Skip to content

Default issue template

Hossein Pursultani requested to merge docs-default-issue-template into main

What does this MR do?

The default template for issues.

Author's checklist

If you are only adding documentation, do NOT add any of the following labels:

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

Reviewer's checklist

Documentation 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 Technical 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 document metadata is present and up-to-date.
    • Ensure the appropriate labels are added to this MR.
    • 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.

Related issues

Edited by Hossein Pursultani

Merge request reports

Loading