From fd7e9d7b26c725445efe5ddfa53d88adfdd2e025 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Claudio=20Andr=C3=A9?= Date: Thu, 16 May 2024 21:51:21 -0300 Subject: [PATCH] docs: note about linking commit message to issue MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit A commit message must refer to problem that motivated its development. Signed-off-by: Claudio André --- .github/pull_request_template.md | 17 +++++++++++++++++ docs/commit-messages.md | 12 ++++++++++++ 2 files changed, 29 insertions(+) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 61591930..a56626a7 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,3 +1,11 @@ +--- +name: PR +about: Create a pull request +title: "" +labels: "" +assignees: "" +--- + ## Describe your changes Add your text here. @@ -13,3 +21,12 @@ Add your text here. - [ ] I have added tests that prove my fix is effective or that my feature works - [ ] New and existing unit tests pass locally with my changes - [ ] If it is a core feature, I have added comprehensive tests. +- [ ] If the issue this PR refers to is a bug report, add the following text to each of the commits + that make it up: + - Fix #VALUE. +- [ ] If the issue this PR refers to is a feature request, add the following text to each of the + commits that make it up: + - Close #VALUE. +- [ ] Commits may not be exactly a fix or implementation of a feature, but they can be related + to any issue, in this case, add the following text to each of the commits that make it up: + - See #VALUE. diff --git a/docs/commit-messages.md b/docs/commit-messages.md index b2ad177f..7de2ff9d 100644 --- a/docs/commit-messages.md +++ b/docs/commit-messages.md @@ -11,6 +11,18 @@ The commit message must follow the format: - The body or description should be restricted to 72 characters per line. - It should explain the motivation for the change. +A commit message must refer to its purpose and to the problem that motivated its development: + +- If the issue a commit refers to is a bug report, add the following text to the + commit message: + - Fix #VALUE. +- If the issue a commit refers to is a feature request, add the following text to + the commit message: + - Close #VALUE. +- Commits may not be exactly a fix or implementation of a feature, but they can be + related to any issue, in this case, add the following text to the commit message: + - See #VALUE. + Examples: ```text