diff options
| author | Dmitry Vyukov <dvyukov@google.com> | 2018-12-03 10:36:40 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-12-03 10:36:40 +0100 |
| commit | 819002b081ae79c079c9694f4e713f4e4a513075 (patch) | |
| tree | 93f17f900f0893a97b48e309568f56b94c093206 /docs/contributing.md | |
| parent | 31677db602dc00be57a68cd68bcf48a829413ddd (diff) | |
docs: update contributing.md
Clarify commit description guidelines.
Diffstat (limited to 'docs/contributing.md')
| -rw-r--r-- | docs/contributing.md | 20 |
1 files changed, 13 insertions, 7 deletions
diff --git a/docs/contributing.md b/docs/contributing.md index c59b4f411..be8eae8b3 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -11,17 +11,23 @@ Some guildelines to follow: - Commit messages should follow the following template: ``` -package: one-line description +dir/path: one-line description <empty line> 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 +`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)). Please pay attention to punctuation. In particular: +- `one-line description` does *not* start with a Capital letter. +- there is *no dot* at the end of `one-line description`. +- `Extended multi-line description` is full English sentenses with Capital letters and dots. + +Also: +- If you commit fixes an issue, please include `Fixes #NNN` line into commit message (where `NNN` is issue number). This will auto-close the issue. If you need to mention an issue without closing it, add `Update #NNN`. +- 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. ## What to work on |