mirrors/qBittorrent
1
0
Fork 0
mirror of https://github.com/qbittorrent/qBittorrent.git synced 2024-11-25 18:56:34 +03:00
Code Issues Projects Releases Packages Wiki Activity

Add Coding Style rules for commit messages

Browse source
This commit is contained in:
Vladimir Golovnev (Glassez) 2018-02-07 18:09:48 +03:00
parent e487b31877
commit ef06485c45
No known key found for this signature in database
GPG key ID: 52A2C7DEE2DFA6F7
1 changed files with 11 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
CODING_GUIDELINES.md
View file

@ -332,5 +332,15 @@ i++, j--; // No
* Method definitions aren't allowed in header files
### 10. Not covered above ###
### 10. Git commit message ###
1. Limit the subject line to 50 characters. Subject should contain only the very essence of the changes (you should avoid extra details and internals)
2. Separate subject from body with a blank line
3. Capitalize the subject line
4. Do not end the subject line with a period
5. Use the imperative mood in the subject line (it's like you're ordering the program to do something (e.g. "Don't create temporary substrings")
6. Wrap the body at 72 characters
7. Use the body to explain what and why vs. how
8. If commit fixes a reported issue, mention it in the message body (e.g. `Closes #4134.`)
### 11. Not covered above ###
If something isn't covered above, just follow the same style the file you are editing has. If that particular detail isn't present in the file you are editing, then use whatever the rest of the project uses.