Contributions to this project are very welcomed and will be fully credited.
We accept contributions via Pull Requests on Github.
- Branch naming conventions: Please specify type of the pull request in the name of the branch. Examples:
- feat/block-details
- chore/bump-dependencies
- bug/wrong-block-number-address-table-transafers
- hotfix/broken-address-route
- Commits: It's important to be concise with your commits. Please follow Conventional Commits Guide.
- Workflow: While workign on the pull request, please add WIP to the title of the PR. When branch is ready, remove 'WIP' and add a comment that it is ready to be merged. Our team will add relevenat tags and merge it.
- Add tests if applicable: Your patch probably won't be accepted if it doesn't have tests (but will depend on the situation).
- One pull request per feature: If you want to do more than one thing, send multiple pull requests.
- Send coherent history: Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please squash them before submitting.
- Document any change in behaviour: Make sure the
README.md, Postman files and any other relevant documentation are kept up-to-date.