aboutsummaryrefslogtreecommitdiffstats
path: root/docs/contributing.md
diff options
context:
space:
mode:
authorAndrey Konovalov <andreyknvl@google.com>2017-06-14 14:13:00 +0200
committerAndrey Konovalov <andreyknvl@google.com>2017-06-14 16:13:33 +0200
commit15826f50875c279b9c7b3c6d26322efe15f24cfb (patch)
treead941027922e67167e7e586eac42c64e5eedaef3 /docs/contributing.md
parentfbec6b14d43b3885014393d928daa3ef2bbb1e8e (diff)
docs: move parts of README to docs
Diffstat (limited to 'docs/contributing.md')
-rw-r--r--docs/contributing.md14
1 files changed, 13 insertions, 1 deletions
diff --git a/docs/contributing.md b/docs/contributing.md
index 88c80b5d1..a7406113a 100644
--- a/docs/contributing.md
+++ b/docs/contributing.md
@@ -1,3 +1,15 @@
## Contributing
-If you want to contribute to the project, you need to [sign Google CLA](https://cla.developers.google.com/) and add yourself to [AUTHORS](AUTHORS)/[CONTRIBUTORS](CONTRIBUTORS) files in the first pull request. Extending/improving [system call descriptions](sys/sys.txt) is always a good idea. If you want to work on something non-trivial, please briefly describe it on [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.
+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).
+
+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
+
+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.