forked from fluxcd/flagger
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add contributing and code of conduct docs
- Loading branch information
1 parent
a4f890c
commit 56f2ee9
Showing
3 changed files
with
150 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,72 @@ | ||
# How to Contribute | ||
|
||
Flagger is [Apache 2.0 licensed](LICENSE) and accepts contributions via GitHub | ||
pull requests. This document outlines some of the conventions on development | ||
workflow, commit message formatting, contact points and other resources to make | ||
it easier to get your contribution accepted. | ||
|
||
We gratefully welcome improvements to 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. | ||
|
||
## Chat | ||
|
||
The project uses Slack: To join the conversation, simply join the | ||
[Weave community](https://slack.weave.works/) Slack workspace. | ||
|
||
## Getting Started | ||
|
||
- Fork the repository on GitHub | ||
- If you want to contribute as a developer, continue reading this document for further instructions | ||
- If you have questions, concerns, get stuck or need a hand, let us know | ||
on the Slack channel. We are happy to help and look forward to having | ||
you part of the team. No matter in which capacity. | ||
- Play with the project, submit bugs, submit pull requests! | ||
|
||
## Contribution workflow | ||
|
||
This is a rough outline of how to prepare a contribution: | ||
|
||
- Create a topic branch from where you want to base your work (usually branched from master). | ||
- Make commits of logical units. | ||
- Make sure your commit messages are in the proper format (see below). | ||
- Push your changes to a topic branch in your fork of the repository. | ||
- If you changed code: | ||
- add automated tests to cover your changes | ||
- Submit a pull request to the original repository. | ||
|
||
## Acceptance policy | ||
|
||
These things will make a PR more likely to be accepted: | ||
|
||
- a well-described requirement | ||
- 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 Flux 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. | ||
|
||
This doc is adapted from the [Weaveworks Flux](https://github.com/weaveworks/flux/blob/master/CONTRIBUTING.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,73 @@ | ||
# Contributor Covenant Code of Conduct | ||
|
||
## Our Pledge | ||
|
||
In the interest of fostering an open and welcoming environment, we as | ||
contributors and maintainers pledge to making participation in our project and | ||
our community a harassment-free experience for everyone, regardless of age, body | ||
size, disability, ethnicity, gender identity and expression, level of experience, | ||
education, socio-economic status, nationality, personal appearance, race, | ||
religion, or sexual identity and orientation. | ||
|
||
## Our Standards | ||
|
||
Examples of behavior that contributes to creating a positive environment | ||
include: | ||
|
||
* Using welcoming and inclusive language | ||
* Being respectful of differing viewpoints and experiences | ||
* Gracefully accepting constructive criticism | ||
* Focusing on what is best for the community | ||
* Showing empathy towards other community members | ||
|
||
Examples of unacceptable behavior by participants include: | ||
|
||
* The use of sexualized language or imagery and unwelcome sexual attention or | ||
advances | ||
* Trolling, insulting/derogatory comments, and personal or political attacks | ||
* Public or private harassment | ||
* Publishing others' private information, such as a physical or electronic | ||
address, without explicit permission | ||
* Other conduct which could reasonably be considered inappropriate in a | ||
professional setting | ||
|
||
## Our Responsibilities | ||
|
||
Project maintainers are responsible for clarifying the standards of acceptable | ||
behavior and are expected to take appropriate and fair corrective action in | ||
response to any instances of unacceptable behavior. | ||
|
||
Project maintainers have the right and responsibility to remove, edit, or | ||
reject comments, commits, code, wiki edits, issues, and other contributions | ||
that are not aligned to this Code of Conduct, or to ban temporarily or | ||
permanently any contributor for other behaviors that they deem inappropriate, | ||
threatening, offensive, or harmful. | ||
|
||
## Scope | ||
|
||
This Code of Conduct applies both within project spaces and in public spaces | ||
when an individual is representing the project or its community. Examples of | ||
representing a project or community include using an official project e-mail | ||
address, posting via an official social media account, or acting as an appointed | ||
representative at an online or offline event. Representation of a project may be | ||
further defined and clarified by project maintainers. | ||
|
||
## Enforcement | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior | ||
may be reported by contacting stefan.prodan(at)gmail.com. | ||
All complaints will be reviewed and investigated and will result in a response that is deemed | ||
necessary and appropriate to the circumstances. The project team is | ||
obligated to maintain confidentiality with regard to the reporter of | ||
an incident. Further details of specific enforcement policies may be | ||
posted separately. | ||
|
||
Project maintainers who do not follow or enforce the Code of Conduct in good | ||
faith may face temporary or permanent repercussions as determined by other | ||
members of the project's leadership. | ||
|
||
## Attribution | ||
|
||
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 1.4, | ||
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html | ||
|