📚 Update CONTRIBUTING.md file.

This commit is contained in:
Andrey Antukh 2021-02-05 15:01:33 +01:00
parent a65a31810c
commit 68ed30ff35

View file

@ -1,8 +1,8 @@
# Contributing Guide # # Contributing Guide #
Thank you for your interest in contributing to Penpot. This is a Thank you for your interest in contributing to Penpot. This is a
generic guide that details how to contribute to Penpot in a way that is generic guide that details how to contribute to Penpot in a way that
efficient for everyone. If you want a specific documentation for is efficient for everyone. If you want a specific documentation for
different parts of the platform, please refer to `docs/` directory. different parts of the platform, please refer to `docs/` directory.
@ -19,6 +19,14 @@ If you found a bug, please report it, as far as possible with:
- a browser and the browser version used - a browser and the browser version used
- a dev tools console exception stack trace (if it is available) - a dev tools console exception stack trace (if it is available)
If you found a bug that you consider better discuse in private (for
example: security bugs), consider first send an email to
`info@penpot.app`.
**We don't have formal bug bounty program for security reports; this
is an open source application and your contribution will be recognized
in the changelog.**
## Pull requests ## ## Pull requests ##
@ -127,7 +135,7 @@ This Code of Conduct is adapted from the Contributor Covenant, version
1.1.0, available from http://contributor-covenant.org/version/1/1/0/ 1.1.0, available from http://contributor-covenant.org/version/1/1/0/
## Contributor License Agreement ## ## Developer's Certificate of Origin (DCO) ##
By submitting code you are agree and can certify the below: By submitting code you are agree and can certify the below:
@ -157,9 +165,9 @@ By submitting code you are agree and can certify the below:
maintained indefinitely and may be redistributed consistent with maintained indefinitely and may be redistributed consistent with
this project or the open source license(s) involved. this project or the open source license(s) involved.
Then, all your patches should contain a sign-off at the end of the Then, all your code patches (**documentation are excluded**) should
patch/commit description body. It can be automatically added on adding contain a sign-off at the end of the patch/commit description body. It
`-s` parameter to `git commit`. can be automatically added on adding `-s` parameter to `git commit`.
This is an example of the aspect of the line: This is an example of the aspect of the line: