Skip to content

Commit

Permalink
improved contributing.md
Browse files Browse the repository at this point in the history
  • Loading branch information
nzambello committed Oct 2, 2017
1 parent 216d951 commit 4303a63
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,10 @@ For testing or development, you can use that example page.
In the `src/` folder you can find the source code, which is written in ES6 and compiled with babel. To build it, run `yarn build`, alternatively you can run `yarn watch` to keep babel running and automatically compiling your changes to the source code.

If you're interested in contributing, you can start with open issues or testing and reviewing code and documentation.

## Code style / project preferences
To have a unique code style across the whole library, even if it's a tiny one, the following common options must be used in any piece of code:
- Indenting with 2 spaces
- Avoid useless comments (use them only if strictly needed)
- We use `yarn` instead of `npm`
- We use semantic versioning for releases (see http://semver.org/)

0 comments on commit 4303a63

Please sign in to comment.