Skip to content

Refactor contractions rules

Evan Read requested to merge eread/refactor-contractions-rules into master

What does this MR do?

Refactors the contractions rules we have along the lines of: technical-writing#218 (closed).

We probably aren't getting a lot of value from splitting them still at this point. We could just use a more generic message that avoids the need to split them at all.

Either way, I think this in an improvement on current state. I've also elevated these to a warning, happy for feedback on that.

I'll send across to @ngaskill and @aqualls for review.

CC @gl-docsteam

Related issues

Closes: technical-writing#218 (closed).

Author's checklist (required)

Do not add the feature, frontend, backend, ~"bug", or database labels if you are only updating documentation. These labels will cause the MR to be added to code verification QA issues.

When applicable:

Review checklist

All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.

1. Primary Reviewer

  • Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.

2. Technical Writer

  • Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.

3. Maintainer

  1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  2. Ensure a release milestone is set.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.
Edited by Marcia Ramos

Merge request reports