Skip to content

Improve MR workflow MR title limit in docs

What does this MR do?

This is a follow up from this Danger message in a MR.

The pipeline Danger checks fail because of:

🚫 The merge request title may not be longer than 72 characters. For more information, take a look at our Commit message guidelines.

However, those MR guidelines don't mention any limit to the MR title.

This MR adds a limit instruction for the MR title in the merge_request_workflow.md file:

1. The MR title should describe the change you want to make.
+   1. The MR title must not be longer than 72 characters.
1. The MR description should give a reason for your change.

Related issues

Author's checklist

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 David Elizondo

Merge request reports