From cd72f4db82a92ece4050f1a0cc8b9d7147d27b4e Mon Sep 17 00:00:00 2001 From: brusdev Date: Tue, 7 Apr 2020 18:34:52 +0200 Subject: [PATCH] NO-JIRA Document NO-JIRA use cases --- docs/hacking-guide/en/code.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/hacking-guide/en/code.md b/docs/hacking-guide/en/code.md index 8c1f9bb4b2..25fa123a06 100644 --- a/docs/hacking-guide/en/code.md +++ b/docs/hacking-guide/en/code.md @@ -76,9 +76,11 @@ related JIRA or an email to the [dev list](http://activemq.apache.org/mailing-li When you commit your changes you will need to supply a commit message. We follow the 50/72 git commit message format. An ActiveMQ Artemis commit message should be formatted in the following manner: - - 1. Add the ARTEMIS JIRA (if one exists) followed by a brief description of the change in the first line. This line - should be limited to 50 characters. + + 1. Add the first line with the summary, using maximum 50 characters. Start the summary with the jira key (ARTEMIS-XXX) + followed by a brief description of the change. Use the prefix `NO-JIRA` only for a very small insignificant change, + like a typo or a small doc fix. Bug fixes, features or any code change, really should be accompanied by a jira, + so they can clearly be reported in the release notes. 1. Insert a single blank line after the first line. 1. Provide a detailed description of the change in the following lines, breaking paragraphs where needed. These lines should be wrapped at 72 characters.