Skip to content

Add trailing spaces check to lefthook

Evan Read requested to merge eread/add-trailing-spaces-check-to-lefthook into master

What does this MR do?

From discussion in: !91423 (merged), this is one way to minimize trailing whitespace being introduced into the documentation suite. Only applies to folks who've opted-in to Lefthook (and are, therefore, accustomed to pushes failing because of checks) and only for Markdown in /doc.

To test:

  1. Check out branch.
  2. Introduce a trailing whitespace error and commit the change.
  3. Run bundle exec lefthook run pre-push.

@kpaizee @dianalogan

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.

Merge request reports

Loading