Skip to content

Latest commit

 

History

History
47 lines (30 loc) · 2.78 KB

CONTRIBUTING.md

File metadata and controls

47 lines (30 loc) · 2.78 KB
Raw

Contributing to Dereck's Notes

Thank you for considering contributing to Dereck's Notes! Your assistance and insights are valued in making the website a fantastic resource for all users. This guide is here to help you get involved in our project.

Getting Started

Setup the Project Locally

  1. Fork the Repository: Click on the 'Fork' button at the top-right corner of this page and clone the forked repository to your local machine.
  2. Navigate into the Project Directory: cd your-project-dir
  3. Install Dependencies: Navigate to both client and server directories and run npm install.
  4. Start the Development Server: In the client directory, run npm run dev and for the server, tsc && node dist/index.js.
  5. Make Changes: Implement your changes, fix a bug, or work on a feature.
  6. Unit Test: Required for changes to the backend API. Navigate to the server directory and run npm test.
  7. Test Your Changes: Ensure they're working as expected and didn't introduce new issues.

Pull Requests

  • Create a New Branch: Create a new branch for each feature, bug fix, or enhancement to keep things organized (git checkout -b new-feature).
  • Commit Your Changes: Make sure your code changes are committed to your new branch.
  • Push to Your Fork: Push the changes to the forked repository on GitHub (git push origin new-feature).
  • Open a Pull Request: Go to your fork on GitHub and click on the 'New Pull Request' button. Make sure the base fork points to the correct repository and branch.

Ensure to describe your changes, what they're intended to do, and any testing that was performed. Linking to relevant issue(s) or discussions is also a good practice.

Issue Creation

When creating an issue, ensure that it's descriptive and provides as much relevant information as possible:

  • Use a Descriptive Title: Clearly state the problem or feature request.
  • Provide Detailed Information: Ensure to describe your issue in detail.
  • Include Screenshots: If applicable, provide screenshots that best illustrate the issue or desired feature.
  • Label the Issue: If possible, assign relevant labels to help maintainers categorize and prioritize the issue.

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Licensing

Ensure to review our license to understand how your contributions will be licensed.

Thank You

Thank you for contributing to Dereck's Notes and ensuring it remains a quality resource for everyone involved. Your efforts are greatly appreciated!

Feel free to reach out for any queries or further clarification on how to get involved.