Skip to content

docs(maintaining): use milestones over boards #3228

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 28, 2021

Conversation

jsjoeio
Copy link
Contributor

@jsjoeio jsjoeio commented Apr 26, 2021

Current Workflow

Right now, the workflow looks a bit like this:

  1. Issue comes in, assign to "triage" and ad relevant labels.
  2. Once triaged is moved to next, it means we are working on it.
  3. It may also get added to a version milestone if it will be out before that milestone is released.

We also have some work being added to the "On Deck" milestone. We would like to reduce any duplicate efforts and align ourselves with one process.

Proposed Workflow

Use milestones instead of project boards (similar to how vscode does it).

Create the following milestones:

  • "Backlog" -> Work not yet planned for a specific release.
  • "On Deck" -> Work under consideration for upcoming milestones
  • "Backlog Candidates" -> Work that is not yet accepted for the Backlog. We wait for the community to weigh in

Month milestones make more sense than version milestones because in the event that a milestone has work that affects the version then we'd need to change the milestone name.

Pros

  • Milestones live closer to the issues
  • Milestones have progress indicators (open vs. closed in milestones)
  • Milestones can have due dates
  • Milestones can have descriptions

Cons

  • Issues can be attached to multiple milestones. This could lead to problems (potentially).

Proposed Changes

Once we this PR is approved, these are the changes I (@jsjoeio) will own and take care of as part of this process:

  • Create "Backlog" milestone
  • Create "Backlog Candidates" milestone
  • Move all issues under "triage" in code-server project board to "Backlog" milestone
  • Move all issues under "Next" in code-server project board to "On Deck" milestone (if not already in version milestone)

Follow-up

  • PR with proposal for changes to our triage workflow
  • PR with proposal for documenting our versioning (aka how we bump versions)
  • refactor/clean up our project boards (hopefully removing all except 🗺️ Roadmap)

@jsjoeio jsjoeio self-assigned this Apr 26, 2021
@jsjoeio jsjoeio added the docs Documentation related label Apr 26, 2021
@jsjoeio jsjoeio added this to the v3.9.4 milestone Apr 26, 2021
@jsjoeio jsjoeio force-pushed the jsjoeio/refactor-board-milestone-workflow branch from 84ed5c5 to 0552967 Compare April 26, 2021 21:57
@jsjoeio jsjoeio marked this pull request as ready for review April 26, 2021 21:58
@jsjoeio jsjoeio requested a review from a team as a code owner April 26, 2021 21:58
@codecov
Copy link

codecov bot commented Apr 26, 2021

Codecov Report

Merging #3228 (9639ed6) into main (9f7ceef) will not change coverage.
The diff coverage is n/a.

❗ Current head 9639ed6 differs from pull request most recent head d07317a. Consider uploading reports for the commit d07317a to get more accurate results
Impacted file tree graph

@@           Coverage Diff           @@
##             main    #3228   +/-   ##
=======================================
  Coverage   46.90%   46.90%           
=======================================
  Files          23       23           
  Lines        1196     1196           
  Branches      237      237           
=======================================
  Hits          561      561           
  Misses        451      451           
  Partials      184      184           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 9f7ceef...d07317a. Read the comment docs.

Copy link
Member

@bpmct bpmct left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this looks great!

@jsjoeio
Copy link
Contributor Author

jsjoeio commented Apr 26, 2021

UPDATE: discussed a bit with @code-asher offline. We're leaning in favor of version milestones (instead of monthly milestones) because of this scenario:

  • issue is attached to April 2021.
  • we decide to cut an early release halfway through (includes fix for issue)
  • issue gets closed, but when I look at milestone, still open because month isn't over (aka milestone not closed)

Now you have to check commits and see if it's in the version or not (more work for maintainers + community).

@jsjoeio jsjoeio requested review from code-asher and oxy April 27, 2021 21:49
Copy link
Member

@code-asher code-asher left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall looks great!

@jsjoeio jsjoeio force-pushed the jsjoeio/refactor-board-milestone-workflow branch 2 times, most recently from 7a8c659 to b206cf2 Compare April 28, 2021 17:38
@jsjoeio jsjoeio force-pushed the jsjoeio/refactor-board-milestone-workflow branch from 9639ed6 to d07317a Compare April 28, 2021 18:25
@repo-ranger repo-ranger bot merged commit ad6a774 into main Apr 28, 2021
@repo-ranger repo-ranger bot deleted the jsjoeio/refactor-board-milestone-workflow branch April 28, 2021 18:41
@jsjoeio jsjoeio added the chore Related to maintenance or clean up label May 14, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore Related to maintenance or clean up docs Documentation related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants