Skip to content

Developer Workflow

Keivan Beigi edited this page Sep 4, 2019 · 3 revisions

πŸ– Taking an Issue

  • All tasks/issues will be posted on our project board.
  • Available tasks are in the To do column and sorted based on priority, You don't always have to pick the topmost task from To do but try not to go more than a couple of issues down.
  • Try to keep your in progress tasks to a minimum, only take additional tasks if they are required for you to complete your work, of it your other issues are blocked.
  • Once you decided on a task, move it to the In progress column and assign it to yourself.

πŸ‘©β€πŸ’» Starting Work

  • Create a branch for the task using kabab case naming format this-is-my-fancy-new-branch
  • Push your branch and create a Draft pull request (PR) right away
  • Add the PR to the Motto project
  • Include a link to the issue in the PR description
  • Attach an estimate label to your PR est:#days based on how long you think the issue is going to take.
  • Once your PR shows up on the board, archive the issue to avoid duplicated items
  • While working on issue, remember to push your changes to GitHub as frequently as you can. At least a couple of times a day.
  • Review your PRs every day and remove/re-add an updated estimate label. The estimates don't have to be linear; they can go up or down based on what you learned/achieved the day before.
  • If you are blocked because of an issue outside of your control, let the team know. Attach a blocked label to your PR/Issue with a comment describing the problem.

🏁 Code Complete

  • Once you are happy with your PR, Rebase/Merge your branch from master
  • Once all automated checks have passed, remove the draft status
  • Move PR to Review column on the project board
  • Assign reviewers to your PR
  • Remember it's your responsibility to follow up with reviewers to review your code or changes they have requested.
  • You can take another issue while your PR is getting reviewed, but addressing comments, getting the PR merged is your top priority.

πŸš€ Merge

  • Don't forget to close the issue

Clone this wiki locally