Skip to content

Add quality criteria to Ruby gem guide

Matthias Käppler requested to merge mk-gemfile-quality-docs into master

What does this MR do?

In #369392 (closed) we found that many gems we use at GitLab have no test automation set up upstream. This means that we do not know how changes in the gem itself, or changes to the runtime environment such as a Ruby upgrade will impact this gem. We also found that some gems are completely unmaintained. In these cases we cannot even submit improvements back upstream but are left with the choice of forking or replacing that dependency.

I added a short list of minimum quality criteria we should apply before adding a new gem to Gemfile.

Related issues

#369392 (closed)

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 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 Matthias Käppler

Merge request reports