Contributing and Feedback

Feel free to address any open issues or add your own issue and fix. We love feedback! Please adhere to the following guidelines.

  1. Create a Github issue outlining the piece of work. Solicit feedback from anyone who has recently contributed to the component of the repository you plan to contribute to.
  2. Checkout a branch from main - preferably name your branch [github username]/[brief description of contribution]
  3. Create a pull request that refers to the created github issue in the commit message.
  4. To link to the github issue, in your commit for example you would simply add in the commit message: [what the PR does briefly] #[commit issue]
  5. Then when you push your commit and create your pull request, Github will automatically link the commit back to the issue. Add more details in the pull request, and request reviewers from anyone who has recently modified related code.
  6. After 1 approval, merge your pull request.