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 CONTRIBUTING.md to include Simplecov #2035

Conversation

corsonknowles
Copy link
Contributor

@corsonknowles corsonknowles commented Feb 9, 2025

Add Simplecov instructions, common usage, and the repo link to our CONTRIBUTING.md guidelines.


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.

@corsonknowles corsonknowles requested a review from a team as a code owner February 9, 2025 15:31
@corsonknowles
Copy link
Contributor Author

corsonknowles commented Feb 9, 2025

@bquorning How does this look?

Amendments and improvements welcome.

.github/CONTRIBUTING.md Outdated Show resolved Hide resolved
.github/CONTRIBUTING.md Outdated Show resolved Hide resolved
.github/CONTRIBUTING.md Outdated Show resolved Hide resolved
@corsonknowles corsonknowles force-pushed the add_simplecov_to_contribution_guidelines branch 2 times, most recently from 86edd21 to 48bb0f6 Compare February 9, 2025 16:32
@bquorning bquorning added this to the Code coverage milestone Feb 9, 2025
Copy link
Collaborator

@bquorning bquorning left a comment

Choose a reason for hiding this comment

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

Do you have mdformat available locally? mdformat . should fix the CI.

.github/CONTRIBUTING.md Outdated Show resolved Hide resolved
@corsonknowles
Copy link
Contributor Author

corsonknowles commented Feb 9, 2025 via email

@corsonknowles corsonknowles force-pushed the add_simplecov_to_contribution_guidelines branch 2 times, most recently from 2dd381a to 8429c46 Compare February 9, 2025 21:50
@corsonknowles
Copy link
Contributor Author

Formatted!

@bquorning
Copy link
Collaborator

Yeah, but… Maybe we should merge #2037 first?

@corsonknowles corsonknowles force-pushed the add_simplecov_to_contribution_guidelines branch from 8429c46 to a7da808 Compare February 9, 2025 22:24
@corsonknowles
Copy link
Contributor Author

corsonknowles commented Feb 9, 2025

Good call! This latest amendment should get it passing enough to merge in either order.

@bquorning bquorning merged commit 01e1f9b into rubocop:master Feb 9, 2025
27 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