diff options
| author | Dmitry Vyukov <dvyukov@google.com> | 2021-04-21 14:59:23 +0200 |
|---|---|---|
| committer | Dmitry Vyukov <dvyukov@google.com> | 2021-04-21 17:21:50 +0200 |
| commit | 2bc8999a98bda25c1c6cad6f8ff4d2bb07ac3be2 (patch) | |
| tree | c4289c7191bc41a8d68832b428ce4739f73f93a4 | |
| parent | ad3ce6afab30fb68cfcda40a1910b87279795c5a (diff) | |
docs: extend contributing.md
Add some general contribution guidelines.
| -rw-r--r-- | docs/contributing.md | 23 |
1 files changed, 17 insertions, 6 deletions
diff --git a/docs/contributing.md b/docs/contributing.md index 8e9189183..2fe771d2d 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -2,6 +2,9 @@ If you want to contribute to the project, feel free to send a pull request following the [guidelines](contributing.md#guidelines) below. +In case this is your first pull request to syzkaller, you will need to [sign Google CLA](https://cla.developers.google.com/) +and add yourself to [AUTHORS](/AUTHORS)/[CONTRIBUTORS](/CONTRIBUTORS) files in the first commit. + ## What to work on Extending/improving [system call descriptions](syscall_descriptions.md) is always a good idea. @@ -10,15 +13,23 @@ Unassigned issues from the [bug tracker](https://github.com/google/syzkaller/iss To contribute code or syscall descriptions, at the very least you need to be able to build and run syzkaller, see the instructions [here](/docs/setup.md). -If you want to work on something non-trivial, please briefly describe it on the [syzkaller@googlegroups.com](https://groups.google.com/forum/#!forum/syzkaller) mailing list first, -so that there is agreement on high level approach and no duplication of work between contributors. - ## Guidelines -In case this is your first pull request to syzkaller, you need to: +If you want to work on something non-trivial, please briefly describe it on the +[syzkaller@googlegroups.com](https://groups.google.com/forum/#!forum/syzkaller) mailing list first, +so that there is an agreement on the high level approach/design and no duplication of work between contributors. + +Split large changes into smaller, logically cohesive commits. Small commits are much easier and faster to review and iterate on. + +Everything that can be reasonably tested should be tested. + +Provide enough documentation for other users to use the new feature. + +Keep the style of the code, tests, comments, docs, log/error messages consistent with the existing style. -- Sign [Google CLA](https://cla.developers.google.com/) (if you don't a bot will ask you to do that). -- Add yourself to [AUTHORS](/AUTHORS)/[CONTRIBUTORS](/CONTRIBUTORS) files in the first commit. +Continuous Integration (CI) system runs a number of tests and some [opinionated] style checks. They need to pass. +You can test locally with `make presubmit`, if you don't have some prerequisites installed, +you may use `syz-env` (see below). ### Commits |