Skip to content

Latest commit

 

History

History
29 lines (17 loc) · 1.87 KB

CONTRIBUTING.md

File metadata and controls

29 lines (17 loc) · 1.87 KB

Contributing

Issues

Issues are precious to this project.

  • Ideas are a valuable source of contributions others can make
  • Problems show where this project is lacking
  • With a question, you show where contributors can improve the user experience

Thank you for creating them.

Commits

Your commit messages should follow Angular commit convention. Therefore we are linting your commits with Husky, meaning you cannot create a non-conventional commit message. If you squash merge your pull request, please make sure you also follow the commit convention in your squashed commit message.

Pull Requests

Pull requests are a great way to get your ideas into this repository. You should be clear which problem you're trying to solve with your contribution. Every pull request will require an approved review before merging.

Linters

This project is using ESLint for linting and Prettier for code formatting. Please follow their standards on contributing. Your code is automatically formatted on saving a file when using VSCode or Atom. Husky ensures that your changes are properly linted before making a commit. If you want to lint manually, you can use lint and lint --fix npm scripts to lint the source code and the test files.

Tests

To run our tests use npm t script. We are using Jest and React Testing Library for testing. Consider creating new test cases when necessary under the __tests__ folder, we want to keep our test covarage above 90%. Use .test.js or .test.jsx suffix for test files and .test.native.js or .test.native.jsx for native tests.