bdde9789db308a9ab2c1510d51b59c6c1afa044e4703aad5ad7df13fda203b6a8a60ff147ba07033e2fc18ad93e5cfd736ac635ce7f6f149a2ee1f11697afd 801 B

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