Skip to content

Commit c97423f

Browse files
ClaudenwClaudenw
committed
initial checkin
1 parent 6502825 commit c97423f

5 files changed

Lines changed: 218 additions & 1 deletion

File tree

‎CODE_OF_CONDUCT.md‎

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

‎CONTRIBUTING.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Welcome!
2+
3+
Contributions are very welcome on {{ PROJECT }}. When contributing please keep this in mind:
4+
5+
- Open an issue to discuss new bigger features.
6+
- Write code consistent with the project style and make sure the tests are passing.
7+
- Stay in touch with us if we have follow up questions or requests for further changes.
8+
9+
# Development
10+
11+
## Local Environment
12+
13+
14+
## Tests
15+
16+
17+
## Static checking and Linting
18+
19+
20+
## Manual testing
21+
22+
23+
### Configuration
24+
25+
26+
# Opening a PR
27+
28+
- Commit messages should describe the changes, not the filenames. Win our admiration by following
29+
the [excellent advice from Chris Beams](https://chris.beams.io/posts/git-commit/) when composing
30+
commit messages.
31+
- Choose a meaningful title for your pull request.
32+
- The pull request description should focus on what changed and why.
33+
- Check that the tests pass (and add test coverage for your changes if appropriate).

‎LICENSE‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,7 @@
186186
same "printed page" as the copyright notice for easier
187187
identification within third-party archives.
188188

189-
Copyright [yyyy] [name of copyright owner]
189+
Copyright (c) 2021 Aiven, Helsinki, Finland. https://aiven.io/
190190

191191
Licensed under the Apache License, Version 2.0 (the "License");
192192
you may not use this file except in compliance with the License.

‎README.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
{{PROJECT_NAME}}
2+
======================
3+
This is a template repository for creating open source repositories at Aiven.
4+
5+
Overview
6+
========
7+
8+
Features
9+
============
10+
11+
Setup
12+
============
13+
14+
License
15+
============
16+
{{PROJECT_NAME}} is licensed under the Apache license, version 2.0. Full license text is available in the [LICENSE](LICENSE) file.
17+
18+
Please note that the project explicitly does not require a CLA (Contributor License Agreement) from its contributors.
19+
20+
Contact
21+
============
22+
Bug reports and patches are very welcome, please post them as GitHub issues and pull requests at https://github.com/aiven/{{PROJECT_NAME}} .
23+
To report any possible vulnerabilities or other serious issues please see our [security](SECURITY.md) policy.

‎SECURITY.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Security Policy
2+
3+
## Supported Versions
4+
5+
We release patches for security vulnerabilities. Which versions are eligible
6+
to receive such patches depend on the CVSS v3.0 Rating:
7+
8+
| CVSS v3.0 | Supported Versions |
9+
| --------- | ----------------------------------------- |
10+
| 4.0-10.0 | Most recent release |
11+
12+
## Reporting a Vulnerability
13+
14+
Please report (suspected) security vulnerabilities to our **[bug bounty
15+
program](https://bugcrowd.com/aiven-mbb-og)**. You will receive a response from
16+
us within 2 working days. If the issue is confirmed, we will release a patch as
17+
soon as possible depending on impact and complexity.
18+
19+
## Qualifying Vulnerabilities
20+
21+
Any reproducible vulnerability that has a severe effect on the security or
22+
privacy of our users is likely to be in scope for the program.
23+
24+
We generally **aren't** interested in the following issues:
25+
* Social engineering (e.g. phishing, vishing, smishing) attacks
26+
* Brute force, DoS, text injection
27+
* Missing best practices such as HTTP security headers (CSP, X-XSS, etc.),
28+
email (SPF/DKIM/DMARC records), SSL/TLS configuration.
29+
* Software version disclosure / Banner identification issues / Descriptive
30+
error messages or headers (e.g. stack traces, application or server errors).
31+
* Clickjacking on pages with no sensitive actions
32+
* Theoretical vulnerabilities where you can't demonstrate a significant
33+
security impact with a proof of concept.

0 commit comments

Comments
 (0)