38 lines
801 B
Markdown
38 lines
801 B
Markdown
|
# Contribution guidelines
|
||
|
|
|
||
|
|
* Install/update the dependencies:
|
||
|
|
```
|
||
|
|
npm install
|
||
|
|
```
|
||
|
|
|
||
|
|
* Make sure the code lints:
|
||
|
|
```
|
||
|
|
npm run lint
|
||
|
|
```
|
||
|
|
|
||
|
|
* Make sure all of the tests pass:
|
||
|
|
```
|
||
|
|
npm test
|
||
|
|
```
|
||
|
|
|
||
|
|
* Adhere to the coding conventions
|
||
|
|
that are used elsewhere in the codebase.
|
||
|
|
|
||
|
|
* New code must have new unit tests.
|
||
|
|
|
||
|
|
* New features
|
||
|
|
or changes to existing features
|
||
|
|
must be documented in the [readme] file.
|
||
|
|
|
||
|
|
* Add yourself to the [authors] file.
|
||
|
|
|
||
|
|
* Feel free to [open an issue][newissue] first,
|
||
|
|
if the change is one that you think
|
||
|
|
needs some discussion.
|
||
|
|
|
||
|
|
[readme]: https://gitlab.com/philbooth/bfj/blob/master/README.md
|
||
|
|
[authors]: https://gitlab.com/philbooth/bfj/blob/master/AUTHORS
|
||
|
|
[newissue]: https://gitlab.com/philbooth/bfj/issues/new
|
||
|
|
[issues]: https://gitlab.com/philbooth/bfj/issues
|
||
|
|
|