From 2780bf32d055877a19ebb1430e4bdf92afdab8e3 Mon Sep 17 00:00:00 2001 From: "Avi Halachmi (:avih)" Date: Sun, 15 Aug 2021 22:15:27 +0300 Subject: DOCS/contrinute: add commit title example prefixes --- DOCS/contribute.md | 5 +++++ 1 file changed, 5 insertions(+) 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. -- cgit v1.2.3