|
| 1 | +# Contribution Guidelines |
| 2 | + |
| 3 | +Anyone is welcome to contribute to this project. Feel free to get in touch with |
| 4 | +other community members on IRC, the mailing list or through issues here on |
| 5 | +GitHub. |
| 6 | + |
| 7 | +[See the README](/README.md) for contact information. |
| 8 | + |
| 9 | +## Bug Reports |
| 10 | + |
| 11 | +You can file issues here on GitHub. Please try to include as much information as |
| 12 | +you can and under what conditions you saw the issue. |
| 13 | + |
| 14 | +## Sending Pull Requests |
| 15 | + |
| 16 | +Patches should be submitted as pull requests (PR). |
| 17 | + |
| 18 | +Before submitting a PR: |
| 19 | +- Your code must run and pass all the automated tests before you submit your PR |
| 20 | + for review. "Work in progress" pull requests are allowed to be submitted, but |
| 21 | + should be clearly labeled as such and should not be merged until all tests |
| 22 | + pass and the code has been reviewed. |
| 23 | +- Your patch should include new tests that cover your changes. It is your and |
| 24 | + your reviewer's responsibility to ensure your patch includes adequate tests. |
| 25 | + |
| 26 | +When submitting a PR: |
| 27 | +- You agree to license your code under the project's open source license |
| 28 | + ([MPL 2.0](/LICENSE)). |
| 29 | +- Base your branch off the current `master`. |
| 30 | +- Add both your code and new tests if relevant. |
| 31 | +- Sign your git commit. |
| 32 | +- Run the test suite to make sure your code passes linting and tests. |
| 33 | +- Ensure your changes do not reduce code coverage of the test suite. |
| 34 | +- Please do not include merge commits in pull requests; include only commits |
| 35 | + with the new relevant code. |
| 36 | + |
| 37 | +## Code Review |
| 38 | + |
| 39 | +This project is production Mozilla code and subject to our [engineering practices and quality standards](https://developer.mozilla.org/en-US/docs/Mozilla/Developer_guide/Committing_Rules_and_Responsibilities). Every patch must be peer reviewed. |
| 40 | + |
| 41 | +## Git Commit Guidelines |
| 42 | + |
| 43 | +We loosely follow the [Angular commit guidelines](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#type) |
| 44 | +of `<type>: <subject>` where `type` must be one of: |
| 45 | + |
| 46 | +* **feat**: A new feature |
| 47 | +* **fix**: A bug fix |
| 48 | +* **docs**: Documentation only changes |
| 49 | +* **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing |
| 50 | + semi-colons, etc) |
| 51 | +* **refactor**: A code change that neither fixes a bug or adds a feature |
| 52 | +* **perf**: A code change that improves performance |
| 53 | +* **test**: Adding missing tests |
| 54 | +* **chore**: Changes to the build process or auxiliary tools and libraries such as documentation |
| 55 | + generation |
| 56 | +* **breaks**: Contains a *BREAKING_CHANGE* to the existing execution environment. |
| 57 | + |
| 58 | +### Subject |
| 59 | + |
| 60 | +The subject contains succinct description of the change: |
| 61 | + |
| 62 | +* use the imperative, present tense: "change" not "changed" nor "changes" |
| 63 | +* don't capitalize first letter |
| 64 | +* no dot (.) at the end |
| 65 | + |
| 66 | +### Body |
| 67 | + |
| 68 | +In order to maintain a reference to the context of the commit, add |
| 69 | +`Closes #<issue_number>` if it closes a related issue or `Issue #<issue_number>` |
| 70 | +if it's a partial fix. |
| 71 | + |
| 72 | +You can also write a detailed description of the commit: Just as in the |
| 73 | +**subject**, use the imperative, present tense: "change" not "changed" nor |
| 74 | +"changes" It should include the motivation for the change and contrast this with |
| 75 | +previous behavior. |
| 76 | + |
| 77 | +### Footer |
| 78 | + |
| 79 | +The footer should contain any information about **Breaking Changes** and is also |
| 80 | +the place to reference GitHub issues that this commit **Closes**. |
| 81 | + |
| 82 | +### Example |
| 83 | + |
| 84 | +A properly formatted commit message should look like: |
| 85 | + |
| 86 | +``` |
| 87 | +feat: give the developers a delicious cookie |
| 88 | +
|
| 89 | +Properly formatted commit messages provide understandable history and |
| 90 | +documentation. This patch will provide a delicious cookie when all tests have |
| 91 | +passed and the commit message is properly formatted. |
| 92 | +
|
| 93 | +BREAKING CHANGE: This patch requires developer to lower expectations about |
| 94 | + what "delicious" and "cookie" may mean. Some sadness may result. |
| 95 | +
|
| 96 | +Closes #3.14, #9.75 |
| 97 | +``` |
0 commit comments