From 0c3dda40b8e985f1b63b922963fc08864da6a66c Mon Sep 17 00:00:00 2001 From: Dmitry Vyukov Date: Wed, 18 Oct 2017 12:31:05 +0200 Subject: Update contributing.md --- docs/contributing.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/contributing.md b/docs/contributing.md index e9b222a38..59e0a9aac 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -9,7 +9,16 @@ and add yourself to [AUTHORS](/AUTHORS)/[CONTRIBUTORS](/CONTRIBUTORS) files (in Some guildelines to follow: -- Prepend each commit with a `package:` prefix, where `package` is the package/tool this commit changes (look at examples in the [commit history](https://github.com/google/syzkaller/commits/master)) +- Commit messages should follow the following template: +``` +package: one-line description + +Extended multi-line description that includes +the problem you are solving and how it is solved. +``` +`package` is the package/tool this commit changes +(look at examples in the [commit history](https://github.com/google/syzkaller/commits/master)) +- The pull request text is mostly irrelevant - Run `make presubmit` and ensure that it passes before sending a PR. It may require some additional packages to be installed (try `sudo make install_prerequisites`) - Rebase your pull request onto the master branch before submitting - If you're asked to add some fixes to your pull requested, please squash the new commits with the old ones -- cgit mrf-deployment