Skip to content

Commit

Permalink
Create CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
rafa8626 committed Oct 21, 2021
1 parent ccb6ef5 commit c828b2d
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
We appreciate the time you are spending to contribute to this project! 🙌

In order to have your pull request merged successfully, keep in mind the following key points:

1. Every change you make, **it has to pass in unit tests**; if it's a new feature, new unit tests need to be added.
2. Once the unit tests are running, we should continue aiming for `70%` and above.
3. There is **NO NEED TO BUILD THE DIST FILES**. Just make sure you modify the `src` folder.
4. Prettier and ESLint were set up to create standardized code, so it is important to follow their guidelines.
5. **No disabling of ESLint rules is allowed**, unless there is a legit reason to do it.

That's it! Thanks again for contributing to this awesome project! Hope to review your work soon 🙂

0 comments on commit c828b2d

Please sign in to comment.