|
| 1 | +# Contributing |
| 2 | + |
| 3 | +We welcome contributions to this project! Please follow these guidelines to ensure a smooth and effective contribution process. |
| 4 | + |
| 5 | +## How to Contribute |
| 6 | + |
| 7 | +- Fork the repository. |
| 8 | +- Create a new branch for your feature or bug fix. |
| 9 | +- Make your changes. |
| 10 | +- Ensure that the tests pass. |
| 11 | +- Submit a pull request with a clear description of your changes. |
| 12 | + |
| 13 | +## Commit Message Format |
| 14 | + |
| 15 | +We use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) for our commit messages. |
| 16 | +This allows for automated changelog generation and release management. |
| 17 | + |
| 18 | +The commit message format is: |
| 19 | +`type(scope?): subject` |
| 20 | + |
| 21 | +The `type` must be one of the following: |
| 22 | +- `build`: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm) |
| 23 | +- `chore`: Other changes that don't modify src or test files |
| 24 | +- `ci`: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs) |
| 25 | +- `docs`: Documentation only changes |
| 26 | +- `feat`: A new feature |
| 27 | +- `fix`: A bug fix |
| 28 | +- `perf`: A code change that improves performance |
| 29 | +- `refactor`: A code change that neither fixes a bug nor adds a feature |
| 30 | +- `revert`: Reverts a previous commit |
| 31 | +- `style`: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) |
| 32 | +- `test`: Adding missing tests or correcting existing tests |
| 33 | + |
| 34 | +The `scope` is optional and can be used to specify the part of the codebase that is affected by the change. |
| 35 | +The `subject` contains a succinct description of the change: |
| 36 | +- Use the imperative, present tense: "add" not "added" nor "adds". |
| 37 | +- Don't capitalize the first letter. |
| 38 | +- No dot (.) at the end. |
| 39 | +- The subject line must not exceed 50 characters. |
| 40 | + |
| 41 | +The `body` of the commit message is optional and should be used to provide additional context. |
| 42 | +- The body should be wrapped at 72 characters. |
0 commit comments