Skip to content

Latest commit

 

History

History
105 lines (61 loc) · 3.86 KB

README.md

File metadata and controls

105 lines (61 loc) · 3.86 KB
Raw

Mozilla Sumo

This repository is used to track anything related to the platform that powers SuMo and any other projects the team might be working on. Kitsune is the platform that powers SuMo (support.mozilla.org).

Engineering Board

We are working mostly with projects. A project signifies the team's focus for a period of time. Usually there are one or two active projects at a time. A project is defined as a standalone chunk of work for a specific property. Recent examples of projects were the redesign of the SUMO site, integrating Firefox Accounts etc.

As a rule of thumb, a project is defined as work that requires more than one tasks to be completed and takes more than 3 working days. Anything that doesn't fall in the project category is a standalone issue. In most of the cases, these issues are bugs.

The board will only display either standalone issues or the issues of the active project(s) in order to avoid clutter.

GitHub Milestones

We are using milestones to better organize the work that a project needs in order to be completed. A milestone is a concrete chunk of work and each project can have more than one milestones.

An example of the above structure is:

  • Site Redesign - project
    • create designs - Milestone1
      • GH issue
      • GH issue
      • GH issue
    • implement designs - Milestone2
      • GH issue
      • GH issue
      • GH issue

Not active projects may have a placeholder milestone in the form of a Inbox if there are already existing issues in board. This is purely for organization reasons.

Labels

Labels are used to easily distinguish cards that have them attached. We should keep them to the minimum in order for the cards that hold them to easily stand out. We are not using priority labels. Priority is determined by the position of a card in the board.

We have the following labels to highlight an issue:

  • Bug: Something is not working properly.

    Any issue that has the bug label should also be assigned to the KTLO GitHub milestone regardless of the severity of the bug.

  • Pr-welcome: Tasks friendly to new contributors. These tasks are only closed when they are done.

  • Project specific labels:

    • oidc
    • other

    If an issue does not have a label then it belongs to kitsune.

Columns

Triage

Default column for incoming issues. Only holds issues that have not been proccessed yet.

Backlog column

Our Parking Lot. Issues that are valid but not yet an immediate priority.

Next Items

Hold the tasks of individual active milestone(s) or standalone tickets that will be worked on within a few weeks.

Projects, Epics and Blocked Items

This column holds all the tasks that require collaboration with project stakeholders or are blocked for any reason. It is also a placeholder for Project/Epic cards. Single cards that hold all the information relevant to a project, links to documentation and its milestones.

In Progress column

Specific tasks that are actively worked on by the team.

A card is moved to the next column only when a PR is opened.

Review column

Anything that waits for a review. An issue is moved to the next column only when merged.

QA column

Everything that is already released to the testing environment and is ready to go under QA.

If an issue passes the QA process, it will be moved to the next column. Otherwise it will be moved back to the In Progress column.

If new issues are opened from the QA processes, they should go under the Next Items column without anyone assigned.

Ready for Release column

Acts as a parking lot. This column is suitable for anything that successfully passed QA but is not yet released to production.

An effort should be put to keep this column short.

Done column

That's all!

Release notes

After each release, we are posting a summary of what happened in Discourse.