Skip to content

Clarify where to find issues to start contributing

Nick Veenhof requested to merge master-patch-afe1 into master

What does this MR do?

We should guide towards the filter of quick win issues combined with seeking community contributions instead of explaining what the label means. The docs were explaining what the labels meant, which is not as useful as guiding people towards an actual list of issues to work on. Decided on guiding them to our most safe list, which is a combination of quick win issues & seeking community contributions Additionally, I don't believe that guiding people to discover what tests to optimize is a path that offers many contributions as this is rather complex. Optimizing existing code is not really a "quick win" and easy to do, increasing the barrier for entry.

Related issues

Author's checklist

If you are a GitLab team member and only adding documentation, do not add any of the following labels:

  • ~"frontend"
  • ~"backend"
  • ~"type::bug"
  • ~"database"

These labels cause the MR to be added to code verification QA issues.

Reviewer's checklist

Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.

If you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.

  • If the content requires it, ensure the information is reviewed by a subject matter expert.
  • Technical writer review items:
    • Ensure docs metadata is present and up-to-date.
    • Ensure the appropriate labels are added to this MR.
    • Ensure a release milestone is set.
    • If relevant to this MR, ensure content topic type principles are in use, including:
      • The headings should be something you'd do a Google search for. Instead of Default behavior, say something like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure GDK.
      • Any task steps should be written as a numbered list.
      • If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
  • Review by assigned maintainer, who can always request/require the reviews above. Maintainer's review can occur before or after a technical writer review.
Edited by Nick Veenhof

Merge request reports

Loading