Team Checklists

For mentors

• Create the Epic issue when doing semester planning (already done for summer)

  • Create the issue
  • Write down the title and description. This usually contains motivations and possible design, but the implementation details are left to the Task issues.
  • Attach labels: EDA or DC? Enhancement or Bug?
  • Add yourself as the assignee
  • Convert this issue to Epic
  • Add the issue to Roadmap and give it a time estimation

  Notes: no need to assign points to Epic issues.

• Break down an Epic issue to several Task issues

  • Create the issue(s)
  • Write down the title and description, containing implementation details.
  • If there are multiple Task issues, set the dependencies.
  • If there are multiple steps in a single Task issue, make steps into a checklist.
  • Attach labels: EDA or DC? Enhancement or Bug?
  • Add the one will do the task as the assignee, or yourself if you are not clear.
  • Add this issue to the Epic, or no nothing if it is a no Epic issue
  • Give it the complexity estimation by comparing to the reference task: Time Series Implementation #133

• Sprint planning

  • Re-estimate [time, priority] of unfinished tasks from the previous Sprint.
  • Create Sprint in the Milestone (version number)
  • Move tasks from Develop Backlog to Sprint Backlog. No Epic should be moved to the Sprint Backlog unless it is also a task. Sort the tasks by their priorities.
  • Assign Milestone for the tasks in the Sprint Backlog.

  Note: sometimes we can put some no Epic tasks to the Sprint.

• Issue triage

  • Check PR list first. If any from outside the team, connect it to an issue if possible.
  • Add module and type labels
  • Add assignee
  • Decide if the issue should be in {Epic, icebox, dev backlog}.
  • If super urgent, put the task into Sprint Backlog.

• Code review

  • Check if previous review comments are resolved
  • Review the code, leave comments and request change, or approve.
  • If approved, merge the commit if all checks passed.
  • Close the issue if all the tasks in the issue are finished.

For whom is contributing the code

• Create PR for an issue

  • Create the PR (draft if partially finished) as earlier as possible
  • If the PR closes an issue, add "Closes #issue-id" to the description or use the Github Linked Issue feature. Otherwise, mention the issue using "This is a part of #issue-id".
  • Drag the corresponding Issue to the In Progress board. Non-team PR will skip this step.

• Asking for code review

  • Resolve any review comments from the previous review
  • Asking your mentor to review the code again