Contributor Recommendations
Lance edited this page Jan 18, 2022
·
1 revision
Here are some recommendations for contributing. The preferred cadence is:
- Issue -> Feature branch from dev branch -> Pull Request in Draft -> Make regular commits -> Regularly rebase -> Set Pull Request for review -> Review completed by two other contributors -> Merge pull request back to dev -> Issue should automatically close -> Feature branch should be deleted.
- Conventional Commits: https://www.conventionalcommits.org/en/v1.0.0/
- Enforce commits with https://commitlint.js.org/#/
- Commit discipline: https://docs.symbolplatform.com/handbook/commit-discipline.html#commit-message-content
- Branching structure: https://docs.symbolplatform.com/handbook/git-branching.html
- Creating a Pull Request: https://opensource.com/article/19/7/create-pull-request-github