diff options
| author | Dmitry Vyukov <dvyukov@google.com> | 2017-06-16 13:14:12 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-06-16 13:14:12 +0200 |
| commit | 0349e2fb7a33d76a6c1616011ad099a056d5d214 (patch) | |
| tree | a76589733f1f4159d794b5c35af6c5343337b4a2 /docs/contributing.md | |
| parent | daf82c6d9e31b7e3d9329430288b8126c4e1f14a (diff) | |
| parent | 71f516782bb401fd3968fdfdb2d211f496cf73c1 (diff) | |
Merge pull request #233 from xairy/up-docs-improve-2
docs: various improvements
Diffstat (limited to 'docs/contributing.md')
| -rw-r--r-- | docs/contributing.md | 16 |
1 files changed, 12 insertions, 4 deletions
diff --git a/docs/contributing.md b/docs/contributing.md index a7406113a..42ecb1858 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -1,15 +1,23 @@ -## Contributing +# How to contribute to syzkaller + +## Guidelines If you want to contribute to the project, feel free to send a pull request. Before sending a pull request you need to [sign Google CLA](https://cla.developers.google.com/) (if you don't a bot will ask you to do that) -and add yourself to [AUTHORS](../AUTHORS)/[CONTRIBUTORS](../CONTRIBUTORS) files (in case this is your first pull request to syzkaller). +and add yourself to [AUTHORS](/AUTHORS)/[CONTRIBUTORS](/CONTRIBUTORS) files (in case this is your first pull request to syzkaller). 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)) - Rebase your pull request onto the master branch before submitting -- If you're asked to add some fixes to your pull requested, please squash them into the commit being fixed +- 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 Extending/improving [system call descriptions](syscall_descriptions.md) is always a good idea. -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. + +Unassigned issues from the [bug tracker](https://github.com/google/syzkaller/issues) are worth doing, but some of them might be complicated. + +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. |