Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 58 additions & 0 deletions CONTRIBUTING.MD
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,64 @@ This is to ensure that:

Read [How to Write a Git Commit Message](https://cbea.ms/git-commit/), for more
on this topic.
Sign your work
--------------

This project is licensed under an open source license. To ensure license compatibility and traceability, we need to keep track of the origin of all commits and make sure they comply with the license terms.
To achieve this, we follow the same procedure as used by the Linux kernel and many other open source projects: **every commit must be signed off**.

The sign-off is a simple line added at the end of your commit message which certifies that you wrote the code or otherwise have the right to pass it on as an open source contribution.
The rules are simple: if you can certify the following statement (from [developercertificate.org](http://developercertificate.org)), then you can sign off your work.

### 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; and

(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:
```bash
Signed-off-by: Your Name your.email@example.com
````

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

If you have set your `user.name` and `user.email` in Git, you can sign off your commits automatically by using:

```bash
git commit -s -m "feat: add new feature"
````

#### Conventional Commits

Expand Down