Rules

Secret ingredients to quality software

Do you know where to discuss the backlog?

Last updated by Tiago Araujo on 28 Sep 2020 05:28 pm (10 months ago) See History

When discussing a PBI/Issue, Pull Request, or a project in general, it is important to do it in the right place.

Kanban on Screen

bad mention pbi
Figure: Bad Example – don't use emails to discuss tasks

For code

Sometimes developers need to discuss code implementations - sometimes to improve the code, other times to explain why something was done a certain way.

This should be done in the Pull Request, if possible comment directly on the line of the code change and once resolved, make sure that the important information is captured in the merge's commit description.

comment on code in pull request
Figure: You can add a comment on a specific line of code

For a new PBI/Issue

As perDo you know when you use @ mentions in a PBI? - Create a new issue mentioning the Product Owner and the related people

Create Issue
Figure: Good Example - When adding a GitHub issue, @ mention the Product Owner and other related people so they receive a notification e.g, an email

For an existing PBI/Issue

Discuss it in the existing PBI/Issue.

existing issue discussion
Figure: You can discuss an existing issue, even when it has been closed

For other topics (brainstorm ideas, general discussion, etc.)

You can:

  • Create a PBI/Issue

    • use a "discussion" label so that others know that it is just a discussion point and not actionable work yet
    • have it checked by the client before publishing it (recommended)
  • Discuss it in the discussion tab in GitHub

Discussion Tab in GitHub
Figure: You can create discussions on your project using the Discussion tab in your GitHub repository

  • In the team channel in Teams

Team channel
Figure: You can discuss your idea in Teams on the team channel

In summary, Email should be the last resort.

Adam CoganAdam Cogan
Matt GoldmanMatt Goldman

We open source. This page is on GitHub