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

CONTRIBUTING: Remove instruction for first-timers to edit the CHANGELOG #10431

Merged
merged 2 commits into from
Feb 21, 2022
Merged

CONTRIBUTING: Remove instruction for first-timers to edit the CHANGELOG #10431

merged 2 commits into from
Feb 21, 2022

Conversation

issyl0
Copy link
Contributor

@issyl0 issyl0 commented Feb 20, 2022


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.

- Apparently this is no longer necessary, automation populates the username links: #10429 (comment).
@bbatsov
Copy link
Collaborator

bbatsov commented Feb 20, 2022

That's still needed if you edit the changelog manually. Perhaps the right thing to do here is to just remove the suggestion for people to do this. :-)

CONTRIBUTING.md Outdated Show resolved Hide resolved
- This can be messy and cause conflicts, and there's sufficient automation in place around the individual `changelog/{type}_{some_cop}.md` entries these days. As a first-time contributor, adding the individual Markdown file with my single change was simpler than navigating the giant `CHANGELOG.md`.
@issyl0
Copy link
Contributor Author

issyl0 commented Feb 21, 2022

@bbatsov Thanks; done!

@koic
Copy link
Member

koic commented Feb 21, 2022

This looks good!

@koic koic merged commit ec581bb into rubocop:master Feb 21, 2022
@issyl0 issyl0 deleted the patch-1 branch February 21, 2022 07:35
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

3 participants