docs: add more details
This commit is contained in:
parent
cbbb21650f
commit
a2955a2a2e
|
@ -3,18 +3,29 @@
|
|||
|
||||
As a contributor, here are the guidelines we would like you to follow:
|
||||
* Ensure `npm run ok` passes before submitting a Pull Request
|
||||
* Please follow semantic-release [commit message guidelines](https://github.com/semantic-release/semantic-release/blob/caribou/CONTRIBUTING.md#commit-message-guidelines)
|
||||
* Features and bug fixes should be covered by new test cases
|
||||
* Commits follow the [Angular commit convention](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines)
|
||||
|
||||
# Reference
|
||||
## Creating releases
|
||||
|
||||
## Static Analysis
|
||||
We use [semantic-release](https://github.com/semantic-release/semantic-release)
|
||||
to release new versions automatically from the `master` branch:
|
||||
* Commits of type `fix` will trigger bugfix releases, think `0.0.1`
|
||||
* Commits of type `feat` will trigger feature releases, think `0.1.0`
|
||||
* Commits with `BREAKING CHANGE` in body or footer will trigger breaking releases, think `1.0.0`
|
||||
|
||||
All other commit types will trigger no new release.
|
||||
|
||||
## Reference
|
||||
|
||||
### Static Analysis
|
||||
eslint and flow-type are used.
|
||||
|
||||
Helpful link: https://www.saltycrane.com/flow-type-cheat-sheet/latest/
|
||||
|
||||
## Testing Framework
|
||||
### Testing Framework
|
||||
https://jestjs.io/
|
||||
|
||||
## API Documentation
|
||||
### API Documentation
|
||||
ESDoc is used to document the public API. See
|
||||
https://esdoc.org/manual/tags.html for details.
|
||||
|
|
Loading…
Reference in New Issue