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 a project spec for future changelog entry #10991

Merged

Conversation

koic
Copy link
Member

@koic koic commented Sep 5, 2022

CHANGELOG.md is already mixed with and without URLs, so direct editing of CHANGELOG.md was hard to prevent formatting without URL, but the new form of adding future changelog entry to the changelog directory can force URL.

Instead of reviewer pointing out, the automated test failure can inform that to reviewee.


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.

CHANGELOG.md is already mixed with and without URLs,
so direct editing of CHANGELOG.md was hard to prevent formatting without URL,
but the new form of adding future changelog entry to the changelog directory can force URL.

Instead of reviewer pointing out, the automated test failure can inform that to reviewee.
@bbatsov bbatsov merged commit 2d8d93f into rubocop:master Sep 12, 2022
@bbatsov
Copy link
Collaborator

bbatsov commented Sep 12, 2022

Good idea!

@koic koic deleted the add_a_project_spec_for_future_changelog_entry branch September 12, 2022 04:41
koic added a commit to rubocop/rubocop-rails that referenced this pull request Sep 23, 2022
koic added a commit to rubocop/rubocop-performance that referenced this pull request Sep 24, 2022
koic added a commit to rubocop/rubocop-minitest that referenced this pull request Sep 25, 2022
richardstewart0213 added a commit to richardstewart0213/performance-build-Performance-optimization-analysis- that referenced this pull request Nov 4, 2022
MarttiCheng added a commit to MarttiCheng/Rubocop-Performance that referenced this pull request Sep 28, 2023
SerhiiMisiura added a commit to SerhiiMisiura/Rubocop-Performance that referenced this pull request Oct 5, 2023
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