summaryrefslogtreecommitdiffstats
path: root/src/seastar/doc/contributing.md
blob: d6a0cbce34e1a9817f6772e2bccceff5c05a75d9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
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.