Skip to content

Commit

Permalink
update contributing guide
Browse files Browse the repository at this point in the history
  • Loading branch information
danh91 committed Aug 9, 2021
1 parent 80c0b8f commit fcfd749
Showing 1 changed file with 48 additions and 3 deletions.
51 changes: 48 additions & 3 deletions docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
* **Do not open up a GitHub issue if the bug is a security vulnerability
in purplship**, and instead send us an email at hello@purplship.com.

* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/PurplShip/purplship/issues).
* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/purplship/purplship/issues).

* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/PurplShip/purplship/issues/new).
* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/purplship/purplship/issues/new).
Be sure to include a **title and clear description**, as much relevant information as possible,
and a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring.

Expand All @@ -23,10 +23,55 @@

### **Do you have questions about the source code?**

* Ask any question about how to use purplship in the [purplship room](https://gitter.im/purplship/purplship).
* Ask any question about how to use purplship in the [purplship community](https://github.com/purplship/purplship-server/discussions).

* Check out the [architecture overview](/architecture)

### Developer Certificate of Origin

purplship is an open source product released under the LGPL v3.0 license (see either [the GNU site](https://www.gnu.org/licenses/lgpl-3.0.en.html) or the [LICENSE file](https://github.com/purplship/purplship/blob/main/LICENSE)). The LGPL v3.0 license allows you to freely use, modify, distribute, and sell your own products that include LGPL v3.0 licensed software.

We respect intellectual property rights of others and we want to make sure all incoming contributions are correctly attributed and licensed. A Developer Certificate of Origin (DCO) is a lightweight mechanism to do that.

The DCO is a declaration attached to every contribution made by every developer. In the commit message of the contribution, the developer simply adds a `Signed-off-by` statement and thereby agrees to the DCO, which you can find below or at [DeveloperCertificate.org](http://developercertificate.org/).

```
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.
```
We require that every contribution to purplship is signed with a Developer Certificate of Origin. Additionally, please use your real name. We do not accept anonymous contributors nor those utilizing pseudonyms.

Each commit must include a DCO which looks like this

```
Signed-off-by: Jane Smith <jane.smith@email.com>
```
You may type this line on your own when writing your commit messages. However, if your user.name and user.email are set in your git configs, you can use `-s` or `--signoff` to add the `Signed-off-by` line to the end of the commit message.


Thanks!

Expand Down

0 comments on commit fcfd749

Please sign in to comment.