@@ -311,6 +311,18 @@ The words "change," "improve," "fix," and "refactor" don't add much information
...
@@ -311,6 +311,18 @@ The words "change," "improve," "fix," and "refactor" don't add much information
For example, "Improve XML generation" could be better written as "Properly escape special characters in XML generation."
For example, "Improve XML generation" could be better written as "Properly escape special characters in XML generation."
For more information about formatting commit messages, please see this excellent [blog post by Tim Pope](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
For more information about formatting commit messages, please see this excellent [blog post by Tim Pope](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
To add more context to a commit message, consider adding information regarding the
origin of the change. For example, the URL of a GitLab issue, or a Jira issue number,
containing more information for users who need in-depth context about the change.
For example:
```plaintext
Properly escape special characters in XML generation.
Issue: gitlab.com/gitlab-org/gitlab/-/issues/1
```
## Testing before merging
## Testing before merging
![Merge requests showing the test states: red, yellow, and green](img/gitlab_flow_ci_mr.png)
![Merge requests showing the test states: red, yellow, and green](img/gitlab_flow_ci_mr.png)