Skip to content

Commit e1a4e05

Browse files
rolandszokesolkimicreb
authored andcommitted
docs(contributing): add documaentation for contributing
1 parent 14fd957 commit e1a4e05

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

CONTRIBUTING.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Contributing
2+
3+
## Issues
4+
5+
Issues are precious to this project.
6+
7+
- **Ideas** are a valuable source of contributions others can make
8+
- **Problems** show where this project is lacking
9+
- With a **question**, you show where contributors can improve the user experience
10+
11+
Thank you for creating them.
12+
13+
## Commits
14+
15+
Your commit messages should follow Angular [commit convention](https://www.conventionalcommits.org/en/v1.0.0-beta.4/). Therefore we are linting your commits with [Husky](https://github.com/typicode/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.
16+
17+
## Pull Requests
18+
19+
Pull requests are a great way to get your ideas into this repository.
20+
You should be clear which problem you're trying to solve with your contribution.
21+
Every pull request will require an approved review before merging.
22+
23+
## Linters
24+
25+
This project is using [ESLint](https://eslint.org/) for linting and [Prettier](https://prettier.io/) for code formatting. Please follow their standards on contributing. Your code is automatically formatted on saving a file when using [VSCode](https://code.visualstudio.com/) or [Atom](https://atom.io/). [Husky](https://github.com/typicode/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 `lint-tests` and `lint-tests-fix` to lint the test files.
26+
27+
## Tests
28+
29+
To run tests use `npm t` script. We are using [Jest](https://jestjs.io/) and [React Testing Library](https://github.com/testing-library/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.
30+
31+
## Build process
32+
33+
TODO

0 commit comments

Comments
 (0)