Skip to content

Contribution Guide

Hirday Gupta edited this page Oct 27, 2018 · 1 revision

The steps to go from "assigned issue" to "pull request"

  1. Go through the issue assigned to you in detail and ask clarifying questions if needed, in the issue thread.
  2. Create a new branch with the name <issue-number>-brief-issue-description. For instance, if creating a branch for issue #43: "Clean up menu code", the branch name should be "43-clean-menu-code". The branch should be based off of the latest commit in development.
  3. Start your work towards solving the issue by pushing commits to the branch. Commits should be logically spaced out and should aid your reviewer in following along with your development process. They should also have good titles and optionally, good descriptions.
  4. If you are resuming your work after a few hours/days, be sure to pull in the latest changes from development into your branch. (If you do not know how to do this, or face issues while doing so, such as an unsolvable merge conflict, feel free to contact me).
  5. After you feel like you hav satisfactorily addressed the issue in your branch, create a Pull Request from that branch to development and await review!

Note: this document is a work-in-progress and will be updated with commonly asked questions/missed details about this workflow.

Clone this wiki locally