From 417973456be430c863a2396446f522226b51e2e4 Mon Sep 17 00:00:00 2001 From: Issy Long Date: Sun, 20 Feb 2022 11:57:31 +0000 Subject: [PATCH 1/2] CONTRIBUTING: Remove instruction for first-timers to edit the CHANGELOG - Apparently this is no longer necessary, automation populates the username links: https://github.com/rubocop/rubocop/pull/10429#discussion_r810593622. --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index dd723a79f44..164f75ce97a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -98,7 +98,7 @@ Here are a few examples: * Describe the brief of the change. The sentence should end with a punctuation. * If this is a breaking change, mark it with `**(Breaking)**`. * At the end of the entry, add an implicit link to your GitHub user page as `([@username][])`. -* Alternatively, you may modify the CHANGELOG.md file directly, but this may result in conflicts later on. Also, if this is your first contribution to RuboCop project, add a link definition for the implicit link to the bottom of the changelog as `[@username]: https://github.com/username`. +* Alternatively, you may modify the CHANGELOG.md file directly, but this may result in conflicts later on. [1]: https://github.com/rubocop/rubocop/issues [2]: https://www.gun.io/blog/how-to-github-fork-branch-and-pull-request From c9518443785c55ecf12357d40a119bf6078c9275 Mon Sep 17 00:00:00 2001 From: Issy Long Date: Mon, 21 Feb 2022 00:22:34 +0000 Subject: [PATCH 2/2] CONTRIBUTING: Remove "modify CHANGELOG directly" suggestion - 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`. --- CONTRIBUTING.md | 1 - 1 file changed, 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 164f75ce97a..26e617f165c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -98,7 +98,6 @@ Here are a few examples: * Describe the brief of the change. The sentence should end with a punctuation. * If this is a breaking change, mark it with `**(Breaking)**`. * At the end of the entry, add an implicit link to your GitHub user page as `([@username][])`. -* Alternatively, you may modify the CHANGELOG.md file directly, but this may result in conflicts later on. [1]: https://github.com/rubocop/rubocop/issues [2]: https://www.gun.io/blog/how-to-github-fork-branch-and-pull-request