...
As compiled by Chris Beams here and listed below, we follow the seven rules of a great git commit message. "Keep in mind: This has all been said before."
...
TL;DR
- Separate subject from body with a blank line
- Limit the subject line to 50 characters
- Capitalize the subject line
- Do not end the subject line with a period
- Use the imperative mood in the subject line
- Wrap the body at 72 characters
- Use the body to explain what and why vs. how
On top of these rules, mind the following Magnolia-specific guidelines:
| Tip |
|---|
- The subject should start with the Jira ticket number, in the appropriate Jira project corresponding to the repository at hand.
- All code changes must belong to a Jira ticket, even if they are "only" considered refactoring. If a ticket does not exist in the current project, please create it and link it as appropriate.
- Please avoid cross-referencing Jira projects from other repositories. This makes it hard to track changes, know when a module should be released, or which ticket/version introduced or fixed an issue.
- Commits only updating internal versions in webapps/bundles may use the motivating Jira ticket from that module, or simply no prefix at all, e.g. "Bump personalization to 2.1-SNAPSHOT".
- QA prefix may be used, but exclusively for 100% cosmetic changes, e.g. formatting, Javadoc.
- Make sure the subject describes and summarizes well what you have done with the commit. The title/issue summary in Jira may be a good starting point, however do not just copy paste!
|
...