diff options
| author | G. Ann Campbell <ann.campbell@sonarsource.com> | 2018-10-31 09:38:33 -0400 |
|---|---|---|
| committer | sonartech <sonartech@sonarsource.com> | 2018-11-01 09:32:50 +0100 |
| commit | b03149205d02251b799b737e3bae76abac0d2166 (patch) | |
| tree | 92f93a76243c008a252a2c0abedae705f3a48684 | |
| parent | 17aed1c52b538ea9028bf394ea2d111e4bdc6eca (diff) | |
| download | sonarqube-b03149205d02251b799b737e3bae76abac0d2166.tar.gz sonarqube-b03149205d02251b799b737e3bae76abac0d2166.zip | |
DOCS update readme with commit msg info
| -rw-r--r-- | server/sonar-docs/README.md | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/server/sonar-docs/README.md b/server/sonar-docs/README.md index ec1c9164310..29f7261b756 100644 --- a/server/sonar-docs/README.md +++ b/server/sonar-docs/README.md @@ -84,6 +84,11 @@ yarn jest This will run the broken link test and stop at the first broken link it finds. Continue running this iteratively until it passes. +## Committing +**Always start your commit message with "DOCS".** + +The convention is to start commit messages with the ticket number the changes are for. Since docs changes are often made without tickets, use "DOCS" instead. + ## Navigation trees Controlling the navigation trees of the tree instances is covered in [static/README.md](static) |