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

Add contribution note to cops documentation generator #12551

Conversation

koic
Copy link
Member

@koic koic commented Dec 17, 2023

Occasionally I reviewed direct edit to cops documentation.

This is similar in intent to the following:
#11563

For source code comments, refer to the AsciiDoc documentation: https://docs.asciidoctor.org/asciidoc/latest/comments/#comment-blocks


Before submitting the PR make sure the following are checked:

  • The PR relates to only one subject with a clear title and description in grammatically correct, complete sentences.
  • Wrote good commit messages.
  • Commit message starts with [Fix #issue-number] (if the related issue exists).
  • Feature branch is up-to-date with master (if not - rebase it).
  • Squashed related commits together.
  • Added tests.
  • Ran bundle exec rake default. It executes all tests and runs RuboCop on its own code.
  • Added an entry (file) to the changelog folder named {change_type}_{change_description}.md if the new code introduces user-observable changes. See changelog entry format for details.

Occasionally I reviewed direct edit to cops documentation.

This is similar in intent to the following:
rubocop#11563

For source code comments, refer to the AsciiDoc documentation:
https://docs.asciidoctor.org/asciidoc/latest/comments/#comment-blocks
@bbatsov bbatsov merged commit 4843acd into rubocop:master Dec 17, 2023
28 checks passed
@bbatsov
Copy link
Collaborator

bbatsov commented Dec 17, 2023

Good idea!

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.

None yet

2 participants