2018-08-22 16:46:37 -07:00
|
|
|
|
2018-09-29 00:29:51 -07:00
|
|
|
✨ Thanks for contributing to **solana-web3.js**! ✨
|
2018-09-28 21:08:58 -07:00
|
|
|
|
|
|
|
|
As a contributor, here are the guidelines we would like you to follow:
|
|
|
|
|
* Ensure `npm run ok` passes before submitting a Pull Request
|
2018-09-29 08:43:26 -07:00
|
|
|
* 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)
|
2018-09-28 21:08:58 -07:00
|
|
|
|
2018-09-29 08:43:26 -07:00
|
|
|
## Creating releases
|
2018-09-28 21:08:58 -07:00
|
|
|
|
2018-09-29 08:43:26 -07:00
|
|
|
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
|
2021-03-15 11:00:43 +08:00
|
|
|
eslint and TypeScript are used.
|
2018-08-22 20:06:29 -07:00
|
|
|
|
2018-09-29 08:43:26 -07:00
|
|
|
### Testing Framework
|
2021-02-06 10:59:00 +08:00
|
|
|
https://mochajs.org/
|
2018-08-22 16:46:37 -07:00
|
|
|
|
2018-09-29 08:43:26 -07:00
|
|
|
### API Documentation
|
2021-03-15 11:00:43 +08:00
|
|
|
TypeDoc is used to document the public API. See
|
|
|
|
|
https://typedoc.org/ for details.
|
