blockworks-foundation
/
solana
mirror of https://github.com/blockworks-foundation/solana.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: add more details

This commit is contained in:
Michael Vines 2018-09-29 08:43:26 -07:00
parent cbbb21650f
commit a2955a2a2e
1 changed files with 16 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
web3.js/CONTRIBUTING.md
View File

@ -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.