| 1 | Contributing
|
| 2 | ============
|
| 3 |
|
| 4 | Thanks for your interest in contributing! The advice below will help you get
|
| 5 | your issue fixed / pull request merged.
|
| 6 |
|
| 7 | Please file bugs and send pull requests to the
|
| 8 | [GitHub repository](https://github.com/mozilla/nunjucks/) and
|
| 9 | [issue tracker](https://github.com/mozilla/nunjucks/issues).
|
| 10 |
|
| 11 |
|
| 12 | Submitting Issues
|
| 13 | -----------------
|
| 14 |
|
| 15 | Issues are easier to reproduce/resolve when they have:
|
| 16 |
|
| 17 | - A pull request with a failing test demonstrating the issue
|
| 18 | - A code example that produces the issue consistently
|
| 19 | - A traceback (when applicable)
|
| 20 |
|
| 21 |
|
| 22 | Pull Requests
|
| 23 | -------------
|
| 24 |
|
| 25 | When creating a pull request:
|
| 26 |
|
| 27 | - Write tests (see below).
|
| 28 | - Note user-facing changes in the `CHANGELOG.md` file.
|
| 29 | - Update the documentation (in `docs/`) as needed.
|
| 30 |
|
| 31 |
|
| 32 | Testing
|
| 33 | -------
|
| 34 |
|
| 35 | Please add tests for any changes you submit. The tests should fail before your
|
| 36 | code changes, and pass with your changes. Existing tests should not break. Test
|
| 37 | coverage (output at the end of every test run) should never decrease after your
|
| 38 | changes.
|
| 39 |
|
| 40 | To install all the requirements for running the tests:
|
| 41 |
|
| 42 | npm install
|
| 43 |
|
| 44 | To run the tests:
|
| 45 |
|
| 46 | npm test
|