Skip to content

Commit e7b7dbc

Browse files
MirahImageMirahImage
committed
Add License, Notice, Contributing, CoC files.
1 parent bd024c0 commit e7b7dbc

File tree

4 files changed

+578
-0
lines changed

4 files changed

+578
-0
lines changed

‎CODE-OF-CONDUCT.md

+127
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,127 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in RabbitMQ Messaging Topology Kubernetes Operator project and our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, religion, or sexual identity
10+
and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the
26+
overall community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or
31+
advances of any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or email
35+
address, without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at [email protected].
63+
All complaints will be reviewed and investigated promptly and fairly.
64+
65+
All community leaders are obligated to respect the privacy and security of the
66+
reporter of any incident.
67+
68+
## Enforcement Guidelines
69+
70+
Community leaders will follow these Community Impact Guidelines in determining
71+
the consequences for any action they deem in violation of this Code of Conduct:
72+
73+
### 1. Correction
74+
75+
**Community Impact**: Use of inappropriate language or other behavior deemed
76+
unprofessional or unwelcome in the community.
77+
78+
**Consequence**: A private, written warning from community leaders, providing
79+
clarity around the nature of the violation and an explanation of why the
80+
behavior was inappropriate. A public apology may be requested.
81+
82+
### 2. Warning
83+
84+
**Community Impact**: A violation through a single incident or series
85+
of actions.
86+
87+
**Consequence**: A warning with consequences for continued behavior. No
88+
interaction with the people involved, including unsolicited interaction with
89+
those enforcing the Code of Conduct, for a specified period of time. This
90+
includes avoiding interactions in community spaces as well as external channels
91+
like social media. Violating these terms may lead to a temporary or
92+
permanent ban.
93+
94+
### 3. Temporary Ban
95+
96+
**Community Impact**: A serious violation of community standards, including
97+
sustained inappropriate behavior.
98+
99+
**Consequence**: A temporary ban from any sort of interaction or public
100+
communication with the community for a specified period of time. No public or
101+
private interaction with the people involved, including unsolicited interaction
102+
with those enforcing the Code of Conduct, is allowed during this period.
103+
Violating these terms may lead to a permanent ban.
104+
105+
### 4. Permanent Ban
106+
107+
**Community Impact**: Demonstrating a pattern of violation of community
108+
standards, including sustained inappropriate behavior, harassment of an
109+
individual, or aggression toward or disparagement of classes of individuals.
110+
111+
**Consequence**: A permanent ban from any sort of public interaction within
112+
the community.
113+
114+
## Attribution
115+
116+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
117+
version 2.0, available at
118+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
119+
120+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
121+
enforcement ladder](https://github.com/mozilla/diversity).
122+
123+
[homepage]: https://www.contributor-covenant.org
124+
125+
For answers to common questions about this code of conduct, see the FAQ at
126+
https://www.contributor-covenant.org/faq. Translations are available at
127+
https://www.contributor-covenant.org/translations.

‎CONTRIBUTING.md

+72
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
# How to Contribute
2+
3+
We'd love to accept your patches and contributions to this project. There are
4+
just a few small guidelines you need to follow.
5+
6+
## GitHub issues
7+
8+
RabbitMQ Messaging Topology Kubernetes Operator team uses GitHub issues for feature development and bug tracking.
9+
The issues have specific information as to what the feature should do and what problem or
10+
use case is trying to resolve. Bug reports have a description of the actual behaviour and
11+
the expected behaviour, along with repro steps when possible. It is important to provide
12+
repro when possible, as it speeds up the triage and potential fix.
13+
14+
We do not use GitHub issues for questions or support requests. For that purpose, it is better
15+
to use [RabbitMQ mailing list][rmq-users] or [RabbitMQ Slack #kubernetes channel][rabbitmq-slack].
16+
17+
For support questions, we strongly encourage you to provide a way to
18+
reproduce the behavior you're observing, or at least sharing as much
19+
relevant information as possible on the [RabbitMQ users mailing
20+
list][rmq-users]. This would include YAML manifests, Kubernetes version,
21+
RabbitMQ Operator logs and any other relevant information that might help
22+
to diagnose the problem.
23+
24+
## Makefile
25+
26+
This project contains a Makefile to perform common development operation. If you want to build, test or deploy a local copy of the repository, keep reading.
27+
28+
#### Make targets
29+
30+
- **controller-gen** Download controller-gen if not in $PATH
31+
32+
### Testing
33+
34+
Before submitting a pull request, ensure all local tests pass
35+
36+
## Pull Requests
37+
38+
RabbitMQ Operator project uses pull requests to discuss, collaborate on and accept code contributions.
39+
Pull requests are the primary place of discussing code changes.
40+
41+
Here's the recommended workflow:
42+
43+
* [Fork the repository][github-fork] or repositories you plan on contributing to. If multiple
44+
repositories are involved in addressing the same issue, please use the same branch name
45+
in each repository
46+
* Create a branch with a descriptive name
47+
* Make your changes, run tests, commit with a [descriptive message][git-commit-msgs], push to your fork
48+
* Submit pull requests with an explanation what has been changed and **why**
49+
* We will get to your pull request within one week. Usually within the next day or two you'll get a response.
50+
51+
If what you are going to work on is a substantial change, please first
52+
ask the core team for their opinion on the [RabbitMQ users mailing list][rmq-users].
53+
54+
### Code Conventions
55+
56+
This project follows the [Kubernetes Code Conventions for Go](https://github.com/kubernetes/community/blob/master/contributors/guide/coding-conventions.md#code-conventions), which in turn mostly refer to [Effective Go](https://golang.org/doc/effective_go.html) and [Go Code Review Comments](https://github.com/golang/go/wiki/CodeReviewComments). Please ensure your pull requests follow these guidelines.
57+
58+
## Code reviews
59+
60+
All submissions, including submissions by project members, require review. We
61+
use GitHub pull requests for this purpose. Consult
62+
[GitHub Help](https://help.github.com/articles/about-pull-requests/) for more
63+
information on using pull requests.
64+
65+
## Community Guidelines
66+
67+
This project follows [Contributor Covenant](./CODE_OF_CONDUCT.md), version 2.0.
68+
69+
[rmq-users]: https://groups.google.com/forum/#!forum/rabbitmq-users
70+
[git-commit-msgs]: https://chris.beams.io/posts/git-commit/
71+
[github-fork]: https://help.github.com/articles/fork-a-repo/
72+
[rabbitmq-slack]: https://rabbitmq-slack.herokuapp.com/

0 commit comments

Comments
 (0)