We welcome contributions with great pleasure!
Depending on the issue you're having, you might want to ask your question on StackOverflow that has a bit more visibility. We're also present there.
All PRs should target the develop
branch.
For bug-fixes, typos, etc. feel free to open one directly. For features, since we made opiniated choices in this project, please open an issue first to double check it is in line with these choices (and avoid losing time).
Our commit convention is based on conventional-changelog-angular.
A commit syntax is <tag>(<scope>): <message>
like so feat(instantsearch): add facets
or docs(contributing): add guidelines
.
The tags used is this project are:
feat
: New feature - Appears in ChangeLogfix
: Bug fix - Appears in ChangeLogperf
: Performance improvement - Appears in ChangeLogrefactor
: Code rewrite without impactstyle
: Design updatedocs
: Documentation (markdown and website) changeschore
: Any other internal change (can be a feat or bug fix that shouldn't be in ChangeLog)
In doubt, don't worry, we'll tell you in your PR.