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

Update references and examples for Capybara cops in documentation #135

Merged
merged 1 commit into from
Oct 17, 2024
Merged

Conversation

ydah
Copy link
Member

@ydah ydah commented Oct 16, 2024

Use bundle exec rake generate_cops_documentation


Before submitting the PR make sure the following are checked:

  • Feature branch is up-to-date with main (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 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.

Use `bundle exec rake generate_cops_documentation `
@ydah ydah requested a review from a team as a code owner October 16, 2024 13:57
@ydah ydah merged commit 88eb2ba into main Oct 17, 2024
25 of 26 checks passed
@ydah ydah deleted the docs branch October 17, 2024 11:28
pirj added a commit to rubocop/rubocop-rspec_rails that referenced this pull request Nov 25, 2024
@pirj pirj mentioned this pull request Nov 25, 2024
4 tasks
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