Skip to content

Avoid contractions in error messages

Mike Jang requested to merge mjang-error-message-no-contractions into master

What does this MR do?

Add criteria for error messages. Inspired by https://gitlab.com/gitlab-org/security/gitlab/-/merge_requests/295#note_299935259

In the future, I think we should go further in error message guidance, to promote "humble, human, and helpful" error messages, ref https://www.writethedocs.org/videos/na/2017/error-messages-being-humble-human-and-helpful-will-make-users-happy-kate-voss/

Related issues

Author's checklist

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

  • Optional: 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