Skip to content

Establish criteria for `quick win` and `quick win::first-time contributor` issues

See parent issue: Issue Discovery Improvement Plan (#512 - closed)

Summary

This issue discusses the criteria to use for quick win and quick winfirst-time contributor issues. This issue is part of the Issue Discovery Improvement Plan (#512 - closed).

Contributors, especially first-time contributors, will be directly guided to find and work on issues with these labels through the upcoming community onboarding steps, the Tutorial, and the contribute to development documentation.

Working draft of criteria

quick win (quick win)

  1. Requires a completed "Implementation plan/guide / Instructions" that broadly outlines what a contributor needs to do in order to complete the issue
    • Check for a non-empty ## Implementation plan section. We could make sure that there is at least one non-empty line between that header and the next one (or the end of the description).
    • If this criteria is not met, the label is removed and a note for the author is left with the instructions & handbook page link on meeting criteria
  2. Requires an issue weight of 0 to 3
    • If this criteria is not met, the label is removed and a note for the author is left with the instructions & handbook page link on meeting criteria
    • While issue weight is quite subjective the point here would be to get the author/team member to consider how challenging the issue might actually be for a contributor when applying the quick win label
  3. Requires a workflowready for development label
    • If this criteria is not met, the label is removed and a note for the author is left with the instructions & handbook page link on meeting criteria
    • This is tricky, while we want contributors to work on valid issues, it makes it difficult for someone to apply the quick win label to an issue that hasn't been validated yet or is in process of being validated.
    • Could also allow any of the Product Development Flow labels e.g. workflowvalidation backlog workflowready for design workflowdesign workflowproblem validation workflowsolution validation etc. indicating validation steps are in place for the issue
    • Contributors are always instructed to validate an issue in a new comment when they find something to work on so it's a question of who we put more responsibility on here

quick win::first-time contributor (quick winfirst-time contributor)

  1. Requires meeting quick win criteria above
    • If this criteria is not met, the label is removed and a note for the author is left with the instructions & handbook page link on meeting criteria
  2. Requires issue weight of 0 to 1
    • If this criteria is not met, the label is removed and a note for the author is left with the instructions & handbook page link on meeting criteria
  3. Requires a workflowready for development label
    • If this criteria is not met, the label is removed and a note for the author is left with the instructions & handbook page link on meeting criteria
  4. Recommends a designated contact for support/questions (e.g. a GitLab team member's name/handle is listed)
    • Have at least one row starting with Support contact: and have one or more usernames after inside of the ## Implementation plan section
    • If this criteria is not met, the label is removed and a note for the author is left with the instructions & handbook page link on meeting criteria
Edited by Arianna Haradon