Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Link related style guide for RSpec/ExampleWithoutDescription #1967

Merged

Conversation

splattael
Copy link
Contributor

@splattael splattael commented Oct 8, 2024

Replace this text with a summary of the changes in your PR. The more detailed you are, the better.


Before submitting the PR make sure the following are checked:

  • Feature branch is up-to-date with master (if not - rebase it).
  • Squashed related commits together.
  • Added tests.
  • Updated documentation.
  • Added an entry to the CHANGELOG.md if the new code introduces user-observable changes.
  • The build (bundle exec rake) passes (be sure to run this locally, since it may produce updated documentation that you will need to commit).

If you have created a new cop:

  • Added the new cop to config/default.yml.
  • The cop is configured as Enabled: pending in config/default.yml.
  • The cop is configured as Enabled: true in .rubocop.yml.
  • The cop documents examples of good and bad code.
  • The tests assert both that bad code is reported and that good code is not reported.
  • Set VersionAdded: "<<next>>" in default/config.yml.

If you have modified an existing cop's configuration options:

  • Set VersionChanged: "<<next>>" in config/default.yml.

@splattael splattael requested a review from a team as a code owner October 8, 2024 12:12
@splattael
Copy link
Contributor Author

I was unsure about the following option and opted not to added a changelog entry:

  • Added an entry to the CHANGELOG.md if the new code introduces user-observable changes.

@splattael splattael force-pushed the example-without-description-styleguide branch from 46ad103 to a4e43cb Compare October 8, 2024 12:14
Copy link
Member

@ydah ydah left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you.

@ydah ydah merged commit e06caeb into rubocop:master Oct 14, 2024
21 of 24 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants