Skip to content

Commit 4071d5f

Browse files
silvexissilvexis
committed
Foundation.
Establish our standards and processes for open source here at CloudZero.
1 parent 1f8ae07 commit 4071d5f

19 files changed

+648
-3
lines changed

‎.github/CODEOWNERS

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* @cloudzero/open-source-maintainers

‎.github/ISSUE_TEMPLATE/bug_report.md

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
name: Report an issue
3+
about: Create a bug report to fix an existing issue.
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
**Please do not report security vulnerabilities here**. Please disclose all security issues to [[email protected]](mailto:[email protected]).
10+
11+
**Thank you in advance for helping us to improve this project!** Please read through the template below and answer all relevant questions. Your additional work here is greatly appreciated and will help us respond as quickly as possible. For general support or usage questions, use [CloudZero Support](mailto:[email protected]). Finally, to avoid duplicates, please search existing Issues before submitting one here.
12+
13+
By submitting an Issue to this repository, you agree to the terms within the [CloudZero Code of Conduct](https://github.com/cloudzero/template-cloudzero-open-source/blob/master/CODE-OF-CONDUCT.md).
14+
15+
### Description
16+
17+
> Provide a clear and concise description of the issue, including what you expected to happen.
18+
19+
### Reproduction
20+
21+
> Detail the steps taken to reproduce this error, what was expected, and whether this issue can be reproduced consistently or if it is intermittent.
22+
>
23+
> Where applicable, please include:
24+
>
25+
> - Code sample to reproduce the issue
26+
> - Log files (redact/remove sensitive information)
27+
> - Application settings (redact/remove sensitive information)
28+
> - Screenshots
29+
30+
### Environment
31+
32+
> Please provide the following:
33+
34+
- **Version of this project used:**
35+
- **Version of the platform or framework used, if applicable:**
36+
- **Other relevant versions (language, server software, OS, browser):**
37+
- **Cloud provider and cloud services used (EKS, K8S, EC2, Etc...)**
38+
- **Other modules/plugins/libraries that might be involved:**

‎.github/ISSUE_TEMPLATE/feature_request.md

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
name: Feature request
3+
about: Suggest new functionality for this project.
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
**Please do not report security vulnerabilities here**. Please disclose all security issues to [[email protected]](mailto:[email protected]).
10+
11+
**Thank you in advance for helping us to improve this project!** Please read through the template below and answer all relevant questions. Your additional work here is greatly appreciated and will help us respond as quickly as possible. For general support or usage questions, use [CloudZero Support](mailto:[email protected]). Finally, to avoid duplicates, please search existing Issues before submitting one here.
12+
13+
By submitting an Issue to this repository, you agree to the terms within the [CloudZero Code of Conduct](https://github.com/cloudzero/template-cloudzero-open-source/blob/master/CODE-OF-CONDUCT.md).
14+
15+
### Describe the problem you'd like to have solved
16+
17+
> A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
18+
19+
### Describe the ideal solution
20+
21+
> A clear and concise description of what you want to happen.
22+
23+
## Alternatives and current work-arounds
24+
25+
> A clear and concise description of any alternatives you've considered or any work-arounds that are currently in place.
26+
27+
### Additional context
28+
29+
> Add any other context or screenshots about the feature request here.

‎.github/PULL_REQUEST_TEMPLATE.md

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
By submitting a PR to this repository, you agree to the terms within the [CloudZero Code of Conduct](https://github.com/cloudzero/template-cloudzero-open-source/blob/master/CODE-OF-CONDUCT.md). Please see the [contributing guidelines](https://github.com/cloudzero/template-cloudzero-open-source/blob/master/CONTRIBUTING.md) for how to create and submit a high-quality PR for this repo.
2+
3+
### Description
4+
5+
> Describe the purpose of this PR along with any background information and the impacts of the proposed change. For the benefit of the community, please do not assume prior context.
6+
>
7+
> Provide details that support your chosen implementation, including: breaking changes, alternatives considered, changes to the API, etc.
8+
>
9+
> If the UI is being changed, please provide screenshots.
10+
11+
12+
### References
13+
14+
> Include any links supporting this change such as a:
15+
>
16+
> - GitHub Issue/PR number addressed or fixed
17+
> - StackOverflow post
18+
> - Support forum thread
19+
> - Related pull requests/issues from other repos
20+
>
21+
> If there are no references, simply delete this section.
22+
23+
### Testing
24+
25+
> Describe how this can be tested by reviewers. Be specific about anything not tested and reasons why. If this library has unit and/or integration testing, tests should be added for new functionality and existing tests should complete without errors.
26+
>
27+
> Please include any manual steps for testing end-to-end or functionality not covered by unit/integration tests.
28+
>
29+
> Also include details of the environment this PR was developed in (language/platform/browser version).
30+
31+
- [ ] This change adds test coverage for new/changed/fixed functionality
32+
33+
### Checklist
34+
35+
- [ ] I have added documentation for new/changed functionality in this PR
36+
- [ ] All active GitHub checks for tests, formatting, and security are passing
37+
- [ ] The correct base branch is being used, if not `main`

‎.github/dependabot.yaml

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Reference: https://docs.github.com/en/github/administering-a-repository/configuration-options-for-dependency-updates
2+
3+
version: 2
4+
updates:
5+
- package-ecosystem: "github-actions"
6+
directory: "/"
7+
schedule:
8+
interval: "weekly"
9+
labels:
10+
- "auto-approve"
11+
open-pull-requests-limit: 5
12+
- package-ecosystem: pip
13+
directory: "/"
14+
schedule:
15+
interval: "weekly"
16+
labels:
17+
- "auto-approve"
18+
open-pull-requests-limit: 5

‎.gitignore

+8
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
# Copyright (c) 2016-2023, CloudZero, Inc. or its affiliates. All Rights Reserved.
2+
# SPDX-License-Identifier: Apache-2.0
3+
# Direct all questions to [email protected]
4+
15
# Byte-compiled / optimized / DLL files
26
__pycache__/
37
*.py[cod]
@@ -127,3 +131,7 @@ dmypy.json
127131

128132
# Pyre type checker
129133
.pyre/
134+
135+
# IDE Cruft
136+
.vscode/
137+
.idea/

‎CHANGELOG.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Change Log
2+
3+
Resources for generating a changelog:
4+
5+
[skywinder/Github-Changelog-Generator](https://github.com/skywinder/Github-Changelog-Generator) - generates a full changelog that overwrites the existing CHANGELOG.md.
6+
7+
[hzalaz/wt-oss-milestone-changelog](https://github.com/hzalaz/wt-oss-milestone-changelog) - generates a snippet of Markdown that can be added to a CHANGELOG.md.
8+
9+
[conventional-changelog/conventional-changelog](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-cli) - generates a full changelog based on commit history with the option to append to an existing changelog.

‎CODE-OF-CONDUCT.md

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

‎CONTRIBUTING.md

+48
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# Contribution
2+
3+
Please read [CloudZero contribution guidelines](https://github.com/cloudzero/open-source-template/blob/master/GENERAL-CONTRIBUTING.md).
4+
5+
## Documentation
6+
7+
- PR for docs site update, if needed
8+
- Code-level documentation expectations
9+
- 100% documentation coverage for PRs
10+
- Include links to relevant CloudZero doc pages
11+
12+
## Assets compilation
13+
14+
Information about compiling CSS, JS, Python, Docker, etc.
15+
16+
## Environment setup
17+
18+
Link to [README installation](README.md#installation) steps and include anything additional needed to contribute to the project.
19+
20+
## Testing
21+
22+
23+
### Adding tests
24+
25+
General information about the test suite and how to format and structure tests.
26+
27+
### Running tests
28+
29+
Any additional information needed to run the test suite. Include `bash`-formatted commands like:
30+
31+
```bash
32+
composer test
33+
bundle exec rake test
34+
```
35+
36+
Also include any information about essential manual tests.
37+
38+
## Code quality tools
39+
40+
Information about scripts to run before committing.
41+
42+
## CI Information
43+
44+
What CI checks for and how to pass.
45+
46+
## Repo-specific PR guidelines
47+
48+
Anything not covered in the general guidelines linked above.

‎FILE-HEADER

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# SPDX-FileCopyrightText: Copyright (c) 2016-2023, CloudZero, Inc. or its affiliates. All Rights Reserved.
2+
# SPDX-License-Identifier: Apache-2.0

0 commit comments

Comments
 (0)