From a2955a2a2edab00e1f7210f197da994e9e073987 Mon Sep 17 00:00:00 2001 From: Michael Vines Date: Sat, 29 Sep 2018 08:43:26 -0700 Subject: [PATCH] docs: add more details --- web3.js/CONTRIBUTING.md | 21 ++++++++++++++++----- 1 file changed, 16 insertions(+), 5 deletions(-) diff --git a/web3.js/CONTRIBUTING.md b/web3.js/CONTRIBUTING.md index 583fba9130..f703fb7e8a 100644 --- a/web3.js/CONTRIBUTING.md +++ b/web3.js/CONTRIBUTING.md @@ -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.