From d895b3be2cffeab3004bc0087a9f3e2b2b790892 Mon Sep 17 00:00:00 2001 From: Dmitry Vyukov Date: Fri, 31 Jul 2020 12:07:23 +0200 Subject: .github/workflows: check commit description format Check PR commit subjects for the standard format we use "pkg/name: description of the change". Check PR commit bodies for at most 120 characters. --- docs/contributing.md | 11 +++++++++++ 1 file changed, 11 insertions(+) (limited to 'docs') diff --git a/docs/contributing.md b/docs/contributing.md index 82453f790..164af916d 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -33,6 +33,15 @@ the problem you are solving and how it is solved. `dir/path` is a relative path to the main dir this commit changes (look at examples in the [commit history](https://github.com/google/syzkaller/commits/master)). +If several packages/dirs are significantly affected, then the following format is allowed: +``` +dir1/path1, dir2/path2: one-line description +``` +Though, dirs should not be included if they have only minor changes. +For pervasive changes the following format is allowed: +``` +all: one-line description +``` Please pay attention to punctuation. In particular: @@ -40,6 +49,8 @@ Please pay attention to punctuation. In particular: - There is *no dot* at the end of `one-line description`. - `Extended multi-line description` is full English sentences with Capital letters and dots. +Commit message line length is limited to 120 characters. + Also: - If you commit fixes an issue, please include `Fixes #NNN` line into commit message -- cgit mrf-deployment