Default issue template
What does this MR do?
The default template for issues.
Author's checklist
-
Ensure the branch name starts with docs-
or ends with-docs
, so only the relevant CI jobs are included. -
Ensure a release milestone is set. -
Follow the: -
MR title and description are up to date, accurate, and descriptive. -
MR targeting the appropriate branch. -
MR has a green pipeline on GitLab.com. -
When ready for review, MR is labeled workflowready for review per the MR workflow. -
If you are a GitLab team member, request a review based on: -
The documentation page's metadata. -
The associated Technical Writer.
-
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
-
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 likeDefault behavior when you close an issue
. -
The headings (other than the page title) should be active. Instead of Configuring GDK
, say something likeConfigure 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