1
0
mirror of https://github.com/OpenRCT2/OpenRCT2 synced 2026-01-29 17:54:50 +01:00

Created Commit Messages (markdown)

Ted John
2016-07-11 23:19:40 +01:00
parent 074b12637e
commit a0986aec0b

35
Commit-Messages.md Normal file

@@ -0,0 +1,35 @@
## Commit Messages
Please follow this guide to write commit messages consistently and correctly.
**Model message:**
```text
Capitalized, short (50 chars or less) summary
More detailed explanatory text, if necessary. Wrap it to about 72
characters or so. In some contexts, the first line is treated as the
subject of an email and the rest of the text as the body. The blank
line separating the summary from the body is critical (unless you omit
the body entirely); tools like rebase can get confused if you run the
two together.
Write your commit message in the present tense: "Fix bug" and not "Fixed
bug." This convention matches up with commit messages generated by
commands like git merge and git revert.
Further paragraphs come after blank lines.
- Bullet points are okay, too
- Typically a hyphen or asterisk is used for the bullet, preceded by a
single space, with blank lines in between, but conventions vary here
- Use a hanging indent
```
**Bug Fix:**
```
Fix #3107: Number of sold items is reset after some time
Number of sold items was being overwritten by a memmove on the field
before it. Queue time changed to only be drawn for rides.
```