diff options
Diffstat (limited to 'src/seastar/doc/contributing.md')
| -rw-r--r-- | src/seastar/doc/contributing.md | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/src/seastar/doc/contributing.md b/src/seastar/doc/contributing.md new file mode 100644 index 000000000..d6a0cbce3 --- /dev/null +++ b/src/seastar/doc/contributing.md @@ -0,0 +1,30 @@ +Contributing to Seastar +======================= + +# Sending Patches +Seastar follows a patch submission similar to Linux. Send patches to seastar-dev, with a DCO signed off message. Use git send-email to send your patch. + +Example: + +1. When you commit, use "-s " in your git commit command, which adds a DCO signed off message. DCO is a "Developer's Certificate of Origin" http://elinux.org/Developer_Certificate_Of_Origin + +For the commit message, you can prefix a tag for an area of the codebase the patch is addressing + + git commit -s -m "core: some descriptive commit message" + +2. then send an email to the google group + + git send-email <revision>..<final_revision> --to seastar-dev@googlegroups.com + +NOTE: for sending replies to patches, use --in-reply-to with the message ID of the original message. Also, if you are sending out a new version of the change, use git rebase and then a `git send-email` with a `-v2`, for instance, to denote that it is a second version. + +# Testing and Approval +Run test.py and ensure tests are passing (at least) as well as before the patch. + + + + + + + + |