1,079
edits
Difference between revisions of "Commit Guidelines"
Added note about empty commit messages
m (Commit-Guidelines moved to Commit Guidelines) |
(Added note about empty commit messages) |
||
| Line 16: | Line 16: | ||
== Examples == | == Examples == | ||
Commit messages like the following aren't very helpful: | Commit messages like the following aren't very helpful: | ||
* "not needed" | * "not needed" -> uhm, what is not needed? | ||
* "bye bye" | * "bye bye" -> was some obsolete code removed? Or did somebody leave the project? Or what? | ||
* "Reverse to match values" -> Reverse which values to match what? | * "Reverse to match values" -> Reverse which values to match what? | ||
* "Move to supported games" -> move what? | * "Move to supported games" -> move what? | ||
| Line 23: | Line 23: | ||
* "One more file to fix" | * "One more file to fix" | ||
* "This difference only applies to SCUMM7+" -> which difference? | * "This difference only applies to SCUMM7+" -> which difference? | ||
* "" -> empty commit messages are about the worst you can do :-/ (short of insults and totally offtopic messages). | |||
Always keep in mind -- those message are often read *without* seeing the diffs, and without the possibility to see which other files you commited just before that particular commit! | Always keep in mind -- those message are often read *without* seeing the diffs, and without the possibility to see which other files you commited just before that particular commit! | ||