| 1 | # Contribution guidelines
|
| 2 |
|
| 3 | * Install/update the dependencies:
|
| 4 | ```
|
| 5 | npm install
|
| 6 | ```
|
| 7 |
|
| 8 | * Make sure the code lints:
|
| 9 | ```
|
| 10 | npm run lint
|
| 11 | ```
|
| 12 |
|
| 13 | * Make sure all of the tests pass:
|
| 14 | ```
|
| 15 | npm test
|
| 16 | ```
|
| 17 |
|
| 18 | * Adhere to the coding conventions
|
| 19 | that are used elsewhere in the codebase.
|
| 20 |
|
| 21 | * New code must have new unit tests.
|
| 22 |
|
| 23 | * New features
|
| 24 | or changes to existing features
|
| 25 | must be documented in the [readme] file.
|
| 26 |
|
| 27 | * Add yourself to the [authors] file.
|
| 28 |
|
| 29 | * Feel free to [open an issue][newissue] first,
|
| 30 | if the change is one that you think
|
| 31 | needs some discussion.
|
| 32 |
|
| 33 | [readme]: https://gitlab.com/philbooth/bfj/blob/master/README.md
|
| 34 | [authors]: https://gitlab.com/philbooth/bfj/blob/master/AUTHORS
|
| 35 | [newissue]: https://gitlab.com/philbooth/bfj/issues/new
|
| 36 | [issues]: https://gitlab.com/philbooth/bfj/issues
|
| 37 |
|
| 38 | |
| \ | No newline at end of file |