|
| 1 | +# Contributing to [Project Name] |
| 2 | + |
| 3 | +This document provides guidelines and instructions for contributing to the project. |
| 4 | + |
| 5 | + |
| 6 | +## Getting Started |
| 7 | + |
| 8 | +1. Fork the repository |
| 9 | +2. Clone your fork: |
| 10 | + ```bash |
| 11 | + git clone https://github.com/your-username/project-name.git |
| 12 | + cd project-name |
| 13 | + ``` |
| 14 | +3. Create a new branch, be descriptive: |
| 15 | + ```bash |
| 16 | + git checkout -b feature/your-feature-name |
| 17 | + |
| 18 | + # OR |
| 19 | + |
| 20 | + git checkout -b bugfix/bug-this-pr-fixes |
| 21 | + |
| 22 | + # OR |
| 23 | + |
| 24 | + git checkout -b docs/documenting-something |
| 25 | + ``` |
| 26 | + |
| 27 | +## Development Workflow |
| 28 | + |
| 29 | +### Testing |
| 30 | + |
| 31 | +- Implement your feature/changes |
| 32 | +- Test any code changes thoroughly |
| 33 | +- Make sure your PR contains all the information for any developer to checkout your branch and validate it |
| 34 | + |
| 35 | + |
| 36 | +### Commit Guidelines (not enforced but nice) |
| 37 | + |
| 38 | +- Your commit message should be under 72 characters |
| 39 | +- Your commit message should start with a topic (e.g.: "Docs: ") |
| 40 | +- Sign-off your commits with `git commit -sm "Feature: Commit subject under 72 characters."` |
| 41 | + |
| 42 | +## Submitting Changes |
| 43 | + |
| 44 | +1. Push your changes to your fork |
| 45 | +2. Submit a pull request towards the `development` branch of this repository |
| 46 | +3. Ensure the PR description clearly describes the problem and solution |
| 47 | +4. Include the relevant issue number if applicable |
| 48 | + |
| 49 | +### Pull Request Process |
| 50 | + |
| 51 | +1. Update documentation if needed: anyone should be able to checkout your branch and validate the changes |
| 52 | +2. Add tests for new features |
| 53 | +3. Wait for review |
| 54 | +4. Upon approval, if you have write access you can merge your PR |
| 55 | + |
| 56 | +### New version/release (maintainers only) |
| 57 | + |
| 58 | +The branch `main` is always assumed to be stable, and new versions are created from there. |
| 59 | +To create a new version of this module: |
| 60 | + |
| 61 | +1. Create a new branch from `main` and name it as the new version (e.g.: `v1.5.5`) |
| 62 | +1. Update the `"version"` field in `package.json` |
| 63 | +1. Run `npm install` to update `package-lock.json` |
| 64 | +1. Validate the above |
| 65 | +1. Commit and push these changes |
| 66 | +1. Open a PR from this new branch to `main` to align version numbers |
| 67 | + |
| 68 | + |
| 69 | +## License |
| 70 | + |
| 71 | +By contributing, you agree that your contributions will be licensed under the project's license. |
0 commit comments