Skip to content

Latest commit

 

History

History
33 lines (17 loc) · 1.21 KB

CONTRIBUTING.md

File metadata and controls

33 lines (17 loc) · 1.21 KB

Contributing

Please read Code of Conduct before contributing.

Report Issues

Report an issue using GitHub Issues. Please fill out the template with as much detail as possible.

GitHub Workflow

  • Fork the repository

  • Clone the forked repository into your working directory

  • Create a new branch using the following naming schema:

    • [fix/feature/...]/[issue-#]-[description-in-kebab-case]

    • For example, feature/6-add-connect-rinkeby-example

  • Commit your changes using the following guidelines:

    • Prefix your commit message with the package you were mainly working on, followed by a colony and space, then the first word is capitalized (e.g. sdk: Fix Colony roles function),
  • Keep your branch up to date using rebase instead of merge

  • Push your new fix/feature branch to your forked repository

  • Create a pull request and fill out the pull request template

Changesets

We are using changesets to keep track of changes across all packages. Please read the Adding a changeset guide before submitting a PR.