summaryrefslogtreecommitdiffstats
path: root/DOCS
diff options
context:
space:
mode:
authorAvi Halachmi (:avih) <avihpit@yahoo.com>2021-08-15 22:15:27 +0300
committerAvi Halachmi (:avih) <avihpit@yahoo.com>2021-08-15 22:15:27 +0300
commit2780bf32d055877a19ebb1430e4bdf92afdab8e3 (patch)
tree9ea3f9a4a9d37fa285b583c03b28fdf136f416c2 /DOCS
parente0df7688f63d57f4f72c99977bd4cedb33e59a71 (diff)
downloadmpv-2780bf32d055877a19ebb1430e4bdf92afdab8e3.tar.bz2
mpv-2780bf32d055877a19ebb1430e4bdf92afdab8e3.tar.xz
DOCS/contrinute: add commit title example prefixes
Diffstat (limited to 'DOCS')
-rw-r--r--DOCS/contribute.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/DOCS/contribute.md b/DOCS/contribute.md
index 48307d9658..c33cab1467 100644
--- a/DOCS/contribute.md
+++ b/DOCS/contribute.md
@@ -68,6 +68,11 @@ Write good commit messages
Having a prefix gives context, and is especially useful when trying to find
a specific change by looking at the history, or when running ``git blame``.
+
+ Sample prefixes: ``vo_gpu: ...``, ``command: ...``, ``DOCS/input: ...``,
+ ``TOOLS/osxbundle: ...``, ``osc.lua: ...``, etc. You can always check the git
+ log for commits which modify specific files to see which prefixes are used.
+
- The first word after the ``:`` is lower case.
- Don't end the subject line with a ``.``.
- Put an empty line between the subject line and the commit message.