Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
98 lines (73 loc) · 3.75 KB

CONTRIBUTING.md

File metadata and controls

98 lines (73 loc) · 3.75 KB

Contributing Guidelines

Thank you for your interest in contributing! 🎉
We welcome all contributions — from bug fixes and documentation improvements to major feature implementations.
Please take a few minutes to review this guide before submitting your contribution.

How to Report Issues

  • Use GitHub Issues for bugs and feature requests.
  • Include as much detail as possible.

Code of Conduct

Please review and follow our Code of Conduct.

License

By contributing, you agree that your contributions are licensed under the MIT License.

🧭 How to Contribute

1. Fork the Repository

Start by forking this repository to your own GitHub account:

git clone https://github.com/CDLUC3/dmsp_backend_prototype.git
cd dmsp_backend_prototype

2. Create a Branch

Create a new branch for your feature or bug fix.

git checkout -b feature/your-feature-name

Please use the following naming convention:

  • feature/your-feature-name for new features
  • bug/your-bug-description for bug fixes
  • docs/your-documentation-update for documentation changes (e.g. README, comments)
  • chore/your-chore-description for maintenance tasks (e.g. updating dependencies)

3. Make Your Changes

Make your changes in your local repository. Please ensure that your code adheres to the project's coding standards and conventions.

For information on how to set up your development environment, please refer to the README.md.

We use eslint for JavaScript/TypeScript linting. You can run the linter with:

npm run lint

We provide an .editorconfig file to help maintain consistent coding styles across different editors and IDEs. Please ensure your editor is configured to use it. For formatting, we use Prettier. You can format your code with:

npm run format

We use a CHANGELOG.md file to document all notable changes made to the project. Please update this file with a brief description of your changes, following the existing format.

4. Test Your Changes

We use Jest for testing. Please write unit tests for your changes and ensure all tests pass before submitting!

npm run test

5. Commit Your Changes

Commit your changes with a clear and concise commit message with what you've done.

git add .
git commit -m "Add your commit message here"

Note that we have a husky precommit hook that will run linting and tests before allowing a commit. Please ensure that your code passes these checks. If you are in the process of making changes and want to commit changes before you have completely finished, you can run the commit with -n to skip these precommit checks.

6. Make sure your branch is up to date

Before pushing your changes, make sure your branch is up to date with the main branch. From your branch run:

git pull origin main

7. Push Your Changes

Push your changes to your forked repository:

git push origin feature/your-feature-name

8. Create a Pull Request

Go to the original repository and create a pull request from your forked repository. Follow the template provided and include as much detail as possible including instructions for how to test the change if applicable. Be sure to reference the issue number if your pull request addresses a specific issue!

9. Address Feedback

We may request changes or provide feedback on your pull request. Please address any feedback promptly to help us review and merge your changes.

We are a small team and may not be able to respond immediately, but we will do our best to review your contribution as soon as possible.

10. Celebrate!

Once your pull request is merged, celebrate your contribution to the project! 🎉