All project discussions should happen in the issue tracker. However if you are a first-time contributor and want some help getting started, feel free to get in touch over email:
- Hassy Veldstra - h@veldstra.org
-
Pull requests should have tests. (We aim for 100% test coverage, which isn't always possible, but test coverage of less than 80% should be considered a bug.)
-
Ideally, pull requests should reference an Issue.
Before you write more than a few lines of code, please make sure that:
- If it's a new feature proposal - that it has been discussed and accepted
- Let others know that you are working on the issue (e.g. by self-assigning the issue)
-
New code should follow the style guidelines These are checked automatically when new code is committed. You can also run the checks at any time yourself with:
# eslint check npm run is_linted
# formatting check (we use Google's JS style) npm run is_formatted
-
Commit messages should follow this style:
(#101) - A brief one-liner < 50 chars Followed by further explanation if needed, this should be wrapped at around 72 characters. Most commits should reference an existing issue, such as #101 above.
Shout out to PouchDB for having a great Contributor's Guide that served as the starting point for this one.