Skip to content

Commit

Permalink
update CONTRIBUTING.md with DCO section (#4924)
Browse files Browse the repository at this point in the history
* update CONTRIBUTING.md with DCO section

Signed-off-by: Michal Piechowiak <misiek.piechowiak@gmail.com>

* Minor tweaks

Signed-off-by: Mike Allanson <michael.allanson@gmail.com>
  • Loading branch information
pieh authored and KyleAMathews committed Apr 10, 2018
1 parent 287338f commit 326073a
Showing 1 changed file with 31 additions and 2 deletions.
33 changes: 31 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 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.
Expand All @@ -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 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

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.

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'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 your last commit if you have a single commit in your Pull Request:

```shell
$ git commit --amend -s
```

## Development tools

### Redux devtools
Expand Down

0 comments on commit 326073a

Please sign in to comment.