mirror of https://github.com/fluxcd/flux2.git
Add coc, dco and maintainers docs
parent
be3f65d800
commit
026d2460f4
@ -0,0 +1,3 @@
|
|||||||
|
## Code of Conduct
|
||||||
|
|
||||||
|
FluxCD toolkit follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md).
|
@ -0,0 +1,68 @@
|
|||||||
|
# Contributing
|
||||||
|
|
||||||
|
FluxCD toolkit is [Apache 2.0 licensed](LICENSE) and accepts contributions
|
||||||
|
via GitHub pull requests. This document outlines some of the conventions on
|
||||||
|
to make it easier to get your contribution accepted.
|
||||||
|
|
||||||
|
We gratefully welcome improvements to issues and documentation as well as to
|
||||||
|
code.
|
||||||
|
|
||||||
|
## Certificate of Origin
|
||||||
|
|
||||||
|
By contributing to this project you agree to the Developer Certificate of
|
||||||
|
Origin (DCO). This document was created by the Linux Kernel community and is a
|
||||||
|
simple statement that you, as a contributor, have the legal right to make the
|
||||||
|
contribution. No action from you is required, but it's a good idea to see the
|
||||||
|
[DCO](DCO) file for details before you start contributing code to FluxCD
|
||||||
|
toolkit.
|
||||||
|
|
||||||
|
## Communications
|
||||||
|
|
||||||
|
The project uses Slack: To join the conversation, simply join the
|
||||||
|
[CNCF](https://slack.cncf.io/) Slack workspace and use the
|
||||||
|
[#flux](https://cloud-native.slack.com/messages/flux/) channel.
|
||||||
|
|
||||||
|
The developers use a mailing list to discuss development as well.
|
||||||
|
Simply subscribe to [flux-dev on cncf.io](https://lists.cncf.io/g/cncf-flux-dev)
|
||||||
|
to join the conversation (this will also add an invitation to your
|
||||||
|
Google calendar for our [Flux
|
||||||
|
meeting](https://docs.google.com/document/d/1l_M0om0qUEN_NNiGgpqJ2tvsF2iioHkaARDeh6b70B0/edit#)).
|
||||||
|
|
||||||
|
### How to run the test suite
|
||||||
|
|
||||||
|
You can run the unit tests by simply doing
|
||||||
|
|
||||||
|
```bash
|
||||||
|
make test
|
||||||
|
```
|
||||||
|
|
||||||
|
## Acceptance policy
|
||||||
|
|
||||||
|
These things will make a PR more likely to be accepted:
|
||||||
|
|
||||||
|
- a well-described requirement
|
||||||
|
- tests for new code
|
||||||
|
- tests for old code!
|
||||||
|
- new code and tests follow the conventions in old code and tests
|
||||||
|
- a good commit message (see below)
|
||||||
|
- all code must abide [Go Code Review Comments](https://github.com/golang/go/wiki/CodeReviewComments)
|
||||||
|
- names should abide [What's in a name](https://talks.golang.org/2014/names.slide#1)
|
||||||
|
- code must build on both Linux and Darwin, via plain `go build`
|
||||||
|
- code should have appropriate test coverage and tests should be written
|
||||||
|
to work with `go test`
|
||||||
|
|
||||||
|
In general, we will merge a PR once one maintainer has endorsed it.
|
||||||
|
For substantial changes, more people may become involved, and you might
|
||||||
|
get asked to resubmit the PR or divide the changes into more than one PR.
|
||||||
|
|
||||||
|
### Format of the Commit Message
|
||||||
|
|
||||||
|
For Source Controller we prefer the following rules for good commit messages:
|
||||||
|
|
||||||
|
- Limit the subject to 50 characters and write as the continuation
|
||||||
|
of the sentence "If applied, this commit will ..."
|
||||||
|
- Explain what and why in the body, if more than a trivial change;
|
||||||
|
wrap it at 72 characters.
|
||||||
|
|
||||||
|
The [following article](https://chris.beams.io/posts/git-commit/#seven-rules)
|
||||||
|
has some more helpful advice on documenting your work.
|
@ -0,0 +1,36 @@
|
|||||||
|
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.
|
||||||
|
|
||||||
|
(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.
|
@ -0,0 +1,8 @@
|
|||||||
|
The maintainers are generally available in Slack at
|
||||||
|
https://cloud-native.slack.com in #flux (https://cloud-native.slack.com/messages/CLAJ40HV3)
|
||||||
|
(obtain an invitation at https://slack.cncf.io/).
|
||||||
|
|
||||||
|
In alphabetical order:
|
||||||
|
|
||||||
|
Hidde Beydals, Weaveworks <hidde@weave.works> (github: @hiddeco, slack: hidde)
|
||||||
|
Stefan Prodan, Weaveworks <stefan@weave.works> (github: @stefanprodan, slack: stefanprodan)
|
Loading…
Reference in New Issue