Skip to content
This repository has been archived by the owner on Nov 5, 2021. It is now read-only.

Latest commit

 

History

History
87 lines (61 loc) · 3.14 KB

CONTRIBUTING.md

File metadata and controls

87 lines (61 loc) · 3.14 KB
Raw

Contributions are welcome

Do not raise a PR unless you've read all of this guide.

This is the contribution process for this repo.

  • Raise a Github issue with the proposed change/idea
  • I'll mark the issue as a feature/bug fix etc for the changelog
  • This gives us a chance to discuss the idea
  • If everything sounds good then go ahead and work on the PR
  • Sign-off every commit with git commit -s to show you agree to the LICENSING terms in this document
  • Please link to the bug and explain how you tested the change
  • I'll merge after reviewing/testing

Note: Dependencies are vendored with vndr

License

This project is licensed under the MIT License.

Copyright notice

Please add a Copyright notice to new files you add where this is not already present:

// Copyright (c) Alex Ellis 2017-2018. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full license information.

Sign your work

Note: all of the commits in your PR/Patch must be signed-off.

The sign-off is a simple line at the end of the explanation for a patch. Your signature certifies that you wrote the patch or otherwise have the right to pass it on as an open-source patch. The rules are pretty simple: if you can certify the below (from developercertificate.org):

Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

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.

Then you just add a line to every git commit message:

Signed-off-by: Joe Smith <joe.smith@email.com>

Use your real name (sorry, no pseudonyms or anonymous contributions.)

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

  • Please sign your commits with git commit -s so that commits are traceable.