summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorChris Waldon <chris.waldon@ibm.com>2020-01-08 10:00:20 -0500
committerPaul Moore <paul@paul-moore.com>2020-01-16 20:26:24 -0500
commit05452332281d60e4116198f1209d74a90c8a3076 (patch)
tree9596c6581ed6ac3bae9336c00438a22ea0b2cec4 /CONTRIBUTING.md
parentc427e5b223cefb4daf6d8c2962a7d2fe102d5130 (diff)
downloadlibseccomp-05452332281d60e4116198f1209d74a90c8a3076.tar.gz
doc: update contribution guide to include github PR info
Signed-off-by: Chris Waldon <chris.waldon@ibm.com> Acked-by: Tom Hromatka <tom.hromatka@oracle.com> Signed-off-by: Paul Moore <paul@paul-moore.com>
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md17
1 files changed, 15 insertions, 2 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index b3507fa..78d5984 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -8,6 +8,11 @@ to the rules described here, but by following the instructions below you
should have a much easier time getting your work merged with the upstream
project.
+libseccomp accepts both GitHub pull requests and patches sent via the mailing
+list. GitHub pull requests are preferred. This guide contains steps that
+explain how to contribute via either method. Please read each step and perform
+all steps that apply to your chosen contriubtion method.
+
## Test Your Code
There are three possible tests you can run to verify your code. The first
@@ -50,7 +55,9 @@ base, and can be enabled via the "--enable-code-coverage" configure flag and
the "check-code-coverage" make target. Additional details on generating code
coverage information can be found in the .travis.yml file.
-## Generate the Patch(es)
+## [Mailing List Only] Generate the Patch(es)
+
+You can skip this if you're submitting a pull request on GitHub.
Depending on how you decided to work with the libseccomp code base and what
tools you are using there are different ways to generate your patch(es).
@@ -120,7 +127,9 @@ your real name, saying:
Signed-off-by: Random J Developer <random@developer.example.org>
-## Email Your Patch(es)
+You can add this to your commit description in `git` with `git commit -s`
+
+## [Mailing List Only] Email Your Patch(es)
Finally, you will need to email your patches to the mailing list so they can
be reviewed and potentially merged into the main libseccomp repository. When
@@ -132,3 +141,7 @@ a problem with your email client. When in doubt try a test first by sending
yourself an email with your patch and attempting to apply the emailed patch to
the libseccomp repository; if it fails for you, it will fail for the rest of
us trying to test your patch and include it in the main libseccomp repository.
+
+## [GitHub Only] Submit Your Pull Request
+
+See [this guide](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request) if you've never done this before.