solana-with-rpc-optimizations/web3.js/CONTRIBUTING.md

21 lines
653 B
Markdown
Raw Normal View History

2018-08-22 16:46:37 -07:00
✨ Thanks for contributing to **solana-web3.js*! ✨
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)
# Reference
2018-08-22 20:06:29 -07:00
## Static Analysis
eslint and flow-type are used.
Helpful link: https://www.saltycrane.com/flow-type-cheat-sheet/latest/
## Testing Framework
2018-08-22 17:03:50 -07:00
https://jestjs.io/
2018-08-22 16:46:37 -07:00
## API Documentation
ESDoc is used to document the public API. See
https://esdoc.org/manual/tags.html for details.