From 3d5b3c5525da7dbf727e9fd59d5349081d348649 Mon Sep 17 00:00:00 2001 From: Sarah Maddox Date: Mon, 23 Apr 2018 11:03:22 +1000 Subject: [PATCH] Added info on signoff via commit statement. Signed-off-by: Sarah Maddox --- CONTRIBUTING.md | 27 ++++++++++++++++++++++++++- README.md | 10 ++++++++++ 2 files changed, 36 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e3f1e223..5cce82a5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,10 +1,25 @@ # Contributing to Project X-Ray + There are a couple of guidelines when contributing to Project X-Ray which are listed here. +### Sending + +All contributions should be sent as +[GitHub Pull requests](https://help.github.com/articles/creating-a-pull-request-from-a-fork/). + +### License + +All code in the Project X-Ray repository is licensed under the very permissive +[ISC Licence](COPYING). A copy can be found in the [`COPYING`](COPYING) file. + +All new contributions must also be released under this license. + ### Code of Conduct -By contributing you agree to the [code of conduct](CODE_OF_CONDUCT.md). +By contributing you agree to the [code of conduct](CODE_OF_CONDUCT.md). We +follow the open source best practice of using the [Contributor +Covenant](https://www.contributor-covenant.org/) for our Code of Conduct. ### Sign your work @@ -54,6 +69,16 @@ then you just add a line saying using your real name (sorry, no pseudonyms or anonymous contributions.) +You can add the signoff as part of your commit statement. For example: + + git commit --signoff -a -m "Fixed some errors." + +*Hint:* If you've forgotten to add a signoff to one or more commits, you can use the +following command to add signoffs to all commits between you and the upstream +master: + + git rebase --signoff upstream/master + diff --git a/README.md b/README.md index 19364638..b1e10bfa 100644 --- a/README.md +++ b/README.md @@ -224,3 +224,13 @@ then you just add a line saying Signed-off-by: Random J Developer using your real name (sorry, no pseudonyms or anonymous contributions.) + +You can add the signoff as part of your commit statement. For example: + + git commit --signoff -a -m "Fixed some errors." + +*Hint:* If you've forgotten to add a signoff to one or more commits, you can use the +following command to add signoffs to all commits between you and the upstream +master: + + git rebase --signoff upstream/master