feat contribution guidelines: add guidelines
License: MIT Signed-off-by: Hector Sanjuan <code@hector.link>
This commit is contained in:
parent
b0d61ab9cb
commit
6d3edbb4a5
56
contribute.md
Normal file
56
contribute.md
Normal file
|
@ -0,0 +1,56 @@
|
|||
# Contribute
|
||||
|
||||
This document gathers a few contributing guidelines for ipfs-cluster. We attempt to go to the point and invite the readers eager for more details
|
||||
to make themselves familiar with:
|
||||
|
||||
* The [go-ipfs contributing guidelines](https://github.com/ipfs/go-ipfs/blob/master/contribute.md) and builds upon:
|
||||
* The [IPFS Community Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md)
|
||||
* The [IFPS community contributing notes](https://github.com/ipfs/community/blob/master/contributing.md)
|
||||
* The [Go contribution guidelines](https://github.com/ipfs/community/blob/master/go-contribution-guidelines.md)
|
||||
|
||||
## General Guidelines
|
||||
|
||||
To check what's going on in the project, check:
|
||||
|
||||
- the [changelog](CHANGELOG.md)
|
||||
- the [Captain's Log](CAPTAIN.LOG.md)
|
||||
- the [Waffle board](https://waffle.io/ipfs/ipfs-cluster)
|
||||
- the [Roadmap](ROADMAP.md)
|
||||
- the [upcoming release issues](https://github.com/ipfs/ipfs-cluster/issues?q=label%3Arelease)
|
||||
|
||||
|
||||
If you need help:
|
||||
|
||||
- open an issue
|
||||
- ask on the `#ipfs-cluster` IRC channel (Freenode)
|
||||
|
||||
|
||||
## Code contribution guidelines
|
||||
|
||||
* ipfs-cluster uses the MIT license.
|
||||
* All contributions are via Pull Request, which needs a Code Review approval from one of the project collaborators.
|
||||
* Tests must pass
|
||||
* Code coverage must be stable or increase
|
||||
* We prefer meaningul branch names: `feat/`, `fix/`...
|
||||
* We prefer commit messages which reference an issue `fix #999: ...`
|
||||
* The commit message should end with the following trailers :
|
||||
|
||||
```
|
||||
License: MIT
|
||||
Signed-off-by: User Name <email@address>
|
||||
```
|
||||
|
||||
where "User Name" is the author's real (legal) name and
|
||||
email@address is one of the author's valid email addresses.
|
||||
|
||||
These trailers mean that the author agrees with the
|
||||
[developer certificate of origin](docs/developer-certificate-of-origin)
|
||||
and with licensing the work under the [MIT license](docs/LICENSE).
|
||||
|
||||
To help you automatically add these trailers, you can run the
|
||||
[setup_commit_msg_hook.sh](https://raw.githubusercontent.com/ipfs/community/master/dev/hooks/setup_commit_msg_hook.sh)
|
||||
script which will setup a Git commit-msg hook that will add the above
|
||||
trailers to all the commit messages you write.
|
||||
|
||||
|
||||
These are just guidelines. We are friendly people and are happy to help :)
|
37
docs/developer-certificate-of-origin
Normal file
37
docs/developer-certificate-of-origin
Normal file
|
@ -0,0 +1,37 @@
|
|||
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.
|
Loading…
Reference in New Issue
Block a user