Skip to content

Suggest to use RSpec.describe instead of describe

Andy Schoenen requested to merge suggest_zero_monkey_patching_in_testing into master

What does this MR do?

I was looking for a place in the docs where we could specify that RSpec.describe Klass is preferred over just describe Klass. I'm not sure if this makes it clear enough though.

The change will be visible here: https://docs.gitlab.com/ee/development/testing_guide/best_practices.html#general-guidelines

Related issues

#220018 (closed)

Author's checklist (required)

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

Skipped for this tiny change

  • [-] 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 🤖 GitLab Bot 🤖

Merge request reports