From f170345646b83e83a72d18b2e3000e313b274e14 Mon Sep 17 00:00:00 2001 From: Andrew Duthie Date: Wed, 11 May 2022 09:30:35 -0400 Subject: [PATCH 1/3] Describe CHANGELOG requirement in contributing guide **Why**: So that a new developer or external contributor knows what to expect, and won't be confused when they see that their build is failing without a changelog. And so that it's more clearly expressed that "[skip changelog]" should ideally be uncommon. --- CONTRIBUTING.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 125a7cc0dba..b3b04275c7d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -26,6 +26,11 @@ pull request is about. - If the pull request is in response to a Jira ticket, include the ticket ID in the commit title (e.g. "LG-1234 Add the stuff to the thing") +- Include a changelog message which should describe the changes in human- +readable terms. These messages are included in release notes, so they should be +easy to understand for our partners and users. In the rare case that a change +should not be included in release notes, add `[skip changelog]` to the commit. + Example: ``` @@ -41,8 +46,12 @@ and making development less efficient. meant to change, and so that only one database call is made. - To prevent the data from being wiped out after each spec, configure Database Cleaner to ignore those static tables. + +changelog: Internal, Automated Testing, Improve performance of test suite ``` +Refer to the [changelog check script](https://github.com/18F/identity-idp/blob/main/scripts/changelog_check.rb) for a complete list of acceptable changelog categories. + ### Style, Readability, and OO - Rubocop or Reek offenses are not disabled unless they are false positives. If you're not sure, please ask a teammate. From 2d287446547aa3283d95fc100d6cd05927e78d59 Mon Sep 17 00:00:00 2001 From: Andrew Duthie Date: Wed, 11 May 2022 09:31:24 -0400 Subject: [PATCH 2/3] Wordsmithing --- CONTRIBUTING.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b3b04275c7d..f247dbc6eda 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -26,10 +26,10 @@ pull request is about. - If the pull request is in response to a Jira ticket, include the ticket ID in the commit title (e.g. "LG-1234 Add the stuff to the thing") -- Include a changelog message which should describe the changes in human- -readable terms. These messages are included in release notes, so they should be -easy to understand for our partners and users. In the rare case that a change -should not be included in release notes, add `[skip changelog]` to the commit. +- Include a changelog message which describes the changes in human-readable +terms. These messages are included in release notes, so they should be easy to +understand for our partners and users. In the rare case that a change should +not be included in release notes, add `[skip changelog]` to the commit. Example: From fd608453ddc2b4d64986d10dbccd2db1775356ab Mon Sep 17 00:00:00 2001 From: Andrew Duthie Date: Wed, 11 May 2022 09:49:41 -0400 Subject: [PATCH 3/3] Column length, reference-style link Follow document convention --- CONTRIBUTING.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f247dbc6eda..bed401f13ce 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -50,7 +50,10 @@ Database Cleaner to ignore those static tables. changelog: Internal, Automated Testing, Improve performance of test suite ``` -Refer to the [changelog check script](https://github.com/18F/identity-idp/blob/main/scripts/changelog_check.rb) for a complete list of acceptable changelog categories. +Refer to the [changelog check script] for a complete list of acceptable +changelog categories. + +[changelog check script]: https://github.com/18F/identity-idp/blob/main/scripts/changelog_check.rb ### Style, Readability, and OO - Rubocop or Reek offenses are not disabled unless they are false positives.