Skip to content

Commit 2eaaf4b

Browse files
committed
Add Contributing and Code of Conduct
1 parent b2fe10b commit 2eaaf4b

File tree

2 files changed

+185
-0
lines changed

2 files changed

+185
-0
lines changed

CODE_OF_CONDUCT.md

Lines changed: 137 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,137 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in 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, caste, color, religion, or sexual
10+
identity 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 overall
26+
community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or advances of
31+
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 address,
35+
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 email 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
63+
the contact form available at
64+
[https://opensource.michelin.io](https://opensource.michelin.io)
65+
All complaints will be reviewed and investigated promptly and fairly.
66+
67+
All community leaders are obligated to respect the privacy and security of the
68+
reporter of any incident.
69+
70+
## Enforcement Guidelines
71+
72+
Community leaders will follow these Community Impact Guidelines in determining
73+
the consequences for any action they deem in violation of this Code of Conduct:
74+
75+
### 1. Correction
76+
77+
**Community Impact**: Use of inappropriate language or other behavior deemed
78+
unprofessional or unwelcome in the community.
79+
80+
**Consequence**: A private, written warning from community leaders, providing
81+
clarity around the nature of the violation and an explanation of why the
82+
behavior was inappropriate. A public apology may be requested.
83+
84+
### 2. Warning
85+
86+
**Community Impact**: A violation through a single incident or series of
87+
actions.
88+
89+
**Consequence**: A warning with consequences for continued behavior. No
90+
interaction with the people involved, including unsolicited interaction with
91+
those enforcing the Code of Conduct, for a specified period of time. This
92+
includes avoiding interactions in community spaces as well as external channels
93+
like social media. Violating these terms may lead to a temporary or permanent
94+
ban.
95+
96+
### 3. Temporary Ban
97+
98+
**Community Impact**: A serious violation of community standards, including
99+
sustained inappropriate behavior.
100+
101+
**Consequence**: A temporary ban from any sort of interaction or public
102+
communication with the community for a specified period of time. No public or
103+
private interaction with the people involved, including unsolicited interaction
104+
with those enforcing the Code of Conduct, is allowed during this period.
105+
Violating these terms may lead to a permanent ban.
106+
107+
### 4. Permanent Ban
108+
109+
**Community Impact**: Demonstrating a pattern of violation of community
110+
standards, including sustained inappropriate behavior, harassment of an
111+
individual, or aggression toward or disparagement of classes of individuals.
112+
113+
**Consequence**: A permanent ban from any sort of public interaction within the
114+
community.
115+
116+
## Attribution
117+
118+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
119+
version 2.1, available at
120+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
121+
122+
Community Impact Guidelines were inspired by
123+
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
124+
125+
For answers to common questions about this code of conduct, see the FAQ at
126+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
127+
[https://www.contributor-covenant.org/translations][translations].
128+
129+
[homepage]: https://www.contributor-covenant.org
130+
131+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
132+
133+
[Mozilla CoC]: https://github.com/mozilla/diversity
134+
135+
[FAQ]: https://www.contributor-covenant.org/faq
136+
137+
[translations]: https://www.contributor-covenant.org/translations

CONTRIBUTING.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# Contributing to Kafka Streams Processing Error Handling
2+
3+
Welcome to our contribution guide.
4+
This guide will help you understand the process and expectations for contributing.
5+
6+
## Getting Started
7+
8+
### Issues
9+
10+
If you want to report a bug, request a feature, or suggest an improvement, please open an issue on the [GitHub repository](https://github.com/michelin/kafka-streams-processing-error-handling/issues)
11+
and fill out the appropriate template.
12+
13+
If you find an existing issue that matches your problem, please:
14+
- Add your reproduction details to the existing issue instead of creating a duplicate.
15+
- Use reactions (e.g., 👍) on the issue to signal that it affects more users. [GitHub reactions](https://github.blog/news-insights/product-news/add-reactions-to-pull-requests-issues-and-comments/) help maintainers prioritize issues based on user impact.
16+
17+
If no open issue addresses your problem, please open a new one and include:
18+
- A clear title and detailed description of the issue.
19+
- Relevant environment details (e.g., version, OS, configurations).
20+
- A code sample or executable test case demonstrating the expected behavior that is not occurring.
21+
22+
### Pull Requests
23+
24+
To contribute to Kafka Streams Processing Error Handling:
25+
26+
- Fork the repository to your own GitHub account
27+
- Clone the project to your machine
28+
- Create a branch from the `main` branch
29+
- Make your changes and commit them to your branch
30+
- Push your changes to your fork
31+
- Open a merge request to the `main` branch of the Kafka Streams Processing Error Handling repository so that we can review your changes
32+
33+
## Style Guide
34+
35+
We maintain a consistent code style using [Spotless](https://github.com/diffplug/spotless/tree/main/plugin-maven).
36+
For Java code, we follow the [Palantir](https://github.com/palantir/palantir-java-format) style.
37+
38+
To check for formatting issues, run:
39+
40+
```bash
41+
mvn spotless:check
42+
```
43+
44+
To automatically fix formatting issues and add missing file headers, run:
45+
46+
```bash
47+
mvn spotless:apply
48+
```

0 commit comments

Comments
 (0)