From 90c89bb7392c195efd4aa8b0c38bb5c1efb29382 Mon Sep 17 00:00:00 2001 From: Matthew Burket Date: Thu, 16 Nov 2023 10:18:25 -0600 Subject: [PATCH 1/2] Add PR title rule to the style guide PR titles are used in the change log we should add a rule to ensure that the titles are useful to the readers of the change log. --- docs/manual/developer/04_style_guide.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/manual/developer/04_style_guide.md b/docs/manual/developer/04_style_guide.md index b8b8a4d82a3..7afd6d955bb 100644 --- a/docs/manual/developer/04_style_guide.md +++ b/docs/manual/developer/04_style_guide.md @@ -25,6 +25,7 @@ * Shall remove the sample text from the template pull request * Shall not have merge commits; they should have to be taken out by [rebasing](https://docs.github.com/en/get-started/using-git/about-git-rebase) * Should target `master` unless pulling an already merged pull request to a stabilization branch +* Shall have a useful title so that it can used in the changelog ### Before Merging From a300203da4f989a8daefbc3fef8b43cf49d22315 Mon Sep 17 00:00:00 2001 From: Matthew Burket Date: Thu, 16 Nov 2023 10:19:08 -0600 Subject: [PATCH 2/2] Fix wording around remove merge commits in style guide --- docs/manual/developer/04_style_guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/manual/developer/04_style_guide.md b/docs/manual/developer/04_style_guide.md index 7afd6d955bb..047d27b26c3 100644 --- a/docs/manual/developer/04_style_guide.md +++ b/docs/manual/developer/04_style_guide.md @@ -23,7 +23,7 @@ * Should follow [the template](https://github.com/ComplianceAsCode/content/blob/master/.github/pull_request_template.md) * Shall remove the sample text from the template pull request -* Shall not have merge commits; they should have to be taken out by [rebasing](https://docs.github.com/en/get-started/using-git/about-git-rebase) +* Shall not have merge commits; they should have been taken out by [rebasing](https://docs.github.com/en/get-started/using-git/about-git-rebase) * Should target `master` unless pulling an already merged pull request to a stabilization branch * Shall have a useful title so that it can used in the changelog