Skip to content

Instantly share code, notes, and snippets.

@visualdensity
Last active July 11, 2019 00:00
Show Gist options
  • Save visualdensity/b4b065862628f9c3e5cf946abe87e946 to your computer and use it in GitHub Desktop.
Save visualdensity/b4b065862628f9c3e5cf946abe87e946 to your computer and use it in GitHub Desktop.

Contributing

We love and welcome your patches and contributions to this project. There are, however, a few things that you will need to follow before we can accept them.

Sign your work

The sign-off is a simple Signed-off-by line added to every commit message. Your sign-off certifies that you agree to the following (from developercertificate.org):

Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
660 York Street, Suite 102,
San Francisco, CA 94110 USA

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.

Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

All you need to do just add a line to every git commit message:

Signed-off-by: FirstName LastName <your@email.com>

Please use your real name (pseudonyms or anonymous contributions are not accepted).

If you set your user.name and user.email git configs, you can sign your commit automatically with git commit -s.

Here's a real-world example of a DCO sign off - chef/chef#8624

Code reviews

All submissions, including submissions by project members, require code reviews in the form of a Pull Request (PR). For more information on how to create a new PR, please refer to this document.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment