From a6d0016e5e46dd2f7b4ac27e5d06a70734d9f8fd Mon Sep 17 00:00:00 2001 From: Michal Piechowiak Date: Tue, 10 Apr 2018 21:16:59 +0200 Subject: [PATCH 1/2] update CONTRIBUTING.md with DCO section Signed-off-by: Michal Piechowiak --- CONTRIBUTING.md | 33 +++++++++++++++++++++++++++++++-- 1 file changed, 31 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8d30ccef35db3..7a129881e2e27 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -54,7 +54,8 @@ The usual contributing steps are: see the [gatsby-dev-cli README](/packages/gatsby-dev-cli/) * Add tests and code for your changes. * Once you're done, make sure all tests still pass: `yarn test` -* Commit and push to your fork. +* Commit with ["Signed-off-by"](#developer-certificate-of-origin) line appended + to commit message and push to your fork. * Create a pull request from your branch. ### Contributing to the documentation. @@ -78,9 +79,37 @@ a pull request. * The Markdown files for the documentation live in `/docs` folder. Make additions or modifications here. * Make sure to double check your grammar and capitalise correctly. -* Commit and push to your fork. +* Commit with ["Signed-off-by"](#developer-certificate-of-origin) line appended + to commit message and push to your fork. * Create a pull request from your branch. +### Developer Certificate of Origin + +Gatsby repository enforces the +[Developer Certificate of Origin](https://developercertificate.org/) (DCO) on +Pull Requests. It requires all commit messages to contain the `Signed-off-by` +line with an email address that matches the commit author. + +Git has a `-s` (or longer `--signoff`) command line option to append this +automatically to your commit message: + +```shell +$ git commit -s -m 'This is my commit message' +``` + +If you already created Pull Request and noticed that DCO check is failing, you +can use this command to append signoff to your commits: + +```shell +$ git rebase --signoff +``` + +or amend last commit if you have single commit in your Pull Request: + +```shell +$ git commit --amend -s +``` + ## Development tools ### Redux devtools From 864b5288b81f4088d6b22696c6af8600b53ac645 Mon Sep 17 00:00:00 2001 From: Mike Allanson Date: Wed, 11 Apr 2018 00:07:07 +0100 Subject: [PATCH 2/2] Minor tweaks Signed-off-by: Mike Allanson --- CONTRIBUTING.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7a129881e2e27..5b0fd6c82fa4f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -54,8 +54,8 @@ The usual contributing steps are: see the [gatsby-dev-cli README](/packages/gatsby-dev-cli/) * Add tests and code for your changes. * Once you're done, make sure all tests still pass: `yarn test` -* Commit with ["Signed-off-by"](#developer-certificate-of-origin) line appended - to commit message and push to your fork. +* Commit with a ["Signed-off-by"](#developer-certificate-of-origin) line appended + to your commit message and push to your fork. * Create a pull request from your branch. ### Contributing to the documentation. @@ -79,13 +79,13 @@ a pull request. * The Markdown files for the documentation live in `/docs` folder. Make additions or modifications here. * Make sure to double check your grammar and capitalise correctly. -* Commit with ["Signed-off-by"](#developer-certificate-of-origin) line appended - to commit message and push to your fork. +* Commit with a ["Signed-off-by"](#developer-certificate-of-origin) line appended + to your commit message and push to your fork. * Create a pull request from your branch. ### Developer Certificate of Origin -Gatsby repository enforces the +The Gatsby repository enforces the [Developer Certificate of Origin](https://developercertificate.org/) (DCO) on Pull Requests. It requires all commit messages to contain the `Signed-off-by` line with an email address that matches the commit author. @@ -97,14 +97,14 @@ automatically to your commit message: $ git commit -s -m 'This is my commit message' ``` -If you already created Pull Request and noticed that DCO check is failing, you -can use this command to append signoff to your commits: +If you've already created a Pull Request and notice that the DCO check is failing, you +can use this command to append a signoff message to your commits: ```shell $ git rebase --signoff ``` -or amend last commit if you have single commit in your Pull Request: +or amend your last commit if you have a single commit in your Pull Request: ```shell $ git commit --amend -s