Skip to content

Commit 2d3ddc4

Browse files
authored
Initial commit
0 parents  commit 2d3ddc4

20 files changed

Lines changed: 905 additions & 0 deletions

.github/CODE_OF_CONDUCT.md

Lines changed: 133 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
2+
# Contributor Covenant Code of Conduct
3+
4+
## Our Pledge
5+
6+
We as members, contributors, and leaders pledge to make participation in our
7+
community a harassment-free experience for everyone, regardless of age, body
8+
size, visible or invisible disability, ethnicity, sex characteristics, gender
9+
identity and expression, level of experience, education, socio-economic status,
10+
nationality, personal appearance, race, caste, color, religion, or sexual
11+
identity and orientation.
12+
13+
We pledge to act and interact in ways that contribute to an open, welcoming,
14+
diverse, inclusive, and healthy community.
15+
16+
## Our Standards
17+
18+
Examples of behavior that contributes to a positive environment for our
19+
community include:
20+
21+
* Demonstrating empathy and kindness toward other people
22+
* Being respectful of differing opinions, viewpoints, and experiences
23+
* Giving and gracefully accepting constructive feedback
24+
* Accepting responsibility and apologizing to those affected by our mistakes,
25+
and learning from the experience
26+
* Focusing on what is best not just for us as individuals, but for the overall
27+
community
28+
29+
Examples of unacceptable behavior include:
30+
31+
* The use of sexualized language or imagery, and sexual attention or advances of
32+
any kind
33+
* Trolling, insulting or derogatory comments, and personal or political attacks
34+
* Public or private harassment
35+
* Publishing others' private information, such as a physical or email address,
36+
without their explicit permission
37+
* Other conduct which could reasonably be considered inappropriate in a
38+
professional setting
39+
40+
## Enforcement Responsibilities
41+
42+
Community leaders are responsible for clarifying and enforcing our standards of
43+
acceptable behavior and will take appropriate and fair corrective action in
44+
response to any behavior that they deem inappropriate, threatening, offensive,
45+
or harmful.
46+
47+
Community leaders have the right and responsibility to remove, edit, or reject
48+
comments, commits, code, wiki edits, issues, and other contributions that are
49+
not aligned to this Code of Conduct, and will communicate reasons for moderation
50+
decisions when appropriate.
51+
52+
## Scope
53+
54+
This Code of Conduct applies within all community spaces, and also applies when
55+
an individual is officially representing the community in public spaces.
56+
Examples of representing our community include using an official e-mail address,
57+
posting via an official social media account, or acting as an appointed
58+
representative at an online or offline event.
59+
60+
## Enforcement
61+
62+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
63+
reported to the community leaders responsible for enforcement at
64+
info@lablabs.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+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
131+
[Mozilla CoC]: https://github.com/mozilla/diversity
132+
[FAQ]: https://www.contributor-covenant.org/faq
133+
[translations]: https://www.contributor-covenant.org/translations

.github/CONTRIBUTING.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Contributing
2+
3+
When contributing to this repository, please first create an issue and link the PR with it.
4+
5+
Please note we have a code of conduct, please follow it in all your interactions with the project.
6+
7+
## Pull Request Process
8+
9+
1. Document your changes in the chart's README.md.gotmpl. The README.md will be generated from it by the pre-commit hook in the next step.
10+
2. Run pre-commit hooks `pre-commit run -a`.
11+
3. Once all outstanding comments and checklist items have been addressed, your contribution will be merged! Merged PRs will be included in the next release.
12+
13+
## Checklists for contributions
14+
15+
- [ ] Add [semantics prefix](#semantic-pull-requests) to your PR or Commits.
16+
- [ ] CI tests are passing
17+
- [ ] README.md has been updated after any changes. The variables and outputs in the README.md has been generated (using the `helm-docs` pre-commit hook)
18+
- [ ] Run pre-commit hooks `pre-commit run -a`
19+
20+
## Semantic Pull Requests
21+
22+
Pull Requests or Commits must follow conventional specs below:
23+
24+
- `ci:` Changes to our CI configuration files and scripts (example scopes: GitHub Actions)
25+
- `docs:` Documentation only changes
26+
- `feat:` A new feature
27+
- `fix:` A bug fix
28+
- `refactor:` A code change that neither fixes a bug nor adds a feature
29+
- `style:` Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
30+
- `test:` Adding missing tests or correcting existing tests
Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
---
2+
name: Bug report
3+
description: File a bug report
4+
title: "bug: "
5+
labels: bug
6+
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: >
11+
**Thank you for reporting a bug!**
12+
13+
Verify first that your issue is not [already reported on
14+
GitHub][issue search].
15+
16+
Also test if the latest release is affected too.
17+
18+
- type: textarea
19+
attributes:
20+
label: Summary
21+
description: Explain the problem briefly below.
22+
placeholder: >-
23+
When I try to do X with the Helm chart from the main branch on GitHub,
24+
Y breaks in a way Z under the env E. Here are all the details I know
25+
about this problem...
26+
validations:
27+
required: true
28+
29+
- type: dropdown
30+
attributes:
31+
label: Issue Type
32+
description: Issue type
33+
options:
34+
- Bug Report
35+
validations:
36+
required: true
37+
38+
- type: input
39+
attributes:
40+
label: Chart version
41+
description: Input the chart version
42+
placeholder: v0.1.0
43+
validations:
44+
required: true
45+
46+
- type: textarea
47+
attributes:
48+
label: Helm version
49+
description: Paste the output of `helm version`
50+
render: console
51+
placeholder: |
52+
$ helm version
53+
version.BuildInfo{Version:"v3.10.2", GitCommit:"50f003e5ee8704ec937a756c646870227d7c8b58", GitTreeState:"clean", GoVersion:"go1.18.8"}
54+
validations:
55+
required: true
56+
57+
- type: textarea
58+
attributes:
59+
label: Kubectl version
60+
description: Paste the output of `kubectl version`
61+
render: console
62+
placeholder: |
63+
$ kubectl version
64+
...
65+
validations:
66+
required: true
67+
68+
- type: textarea
69+
attributes:
70+
label: Steps to reproduce
71+
description: Enter details about how to reproduce the bug.
72+
placeholder: |
73+
1. In this environment...
74+
2. With this config...
75+
3. Run '...'
76+
4. See error...
77+
validations:
78+
required: true
79+
80+
- type: textarea
81+
attributes:
82+
label: Expected Results
83+
description: Describe what you expected to happen.
84+
placeholder: I expected X to happen because I assumed Y.
85+
validations:
86+
required: true
87+
88+
- type: textarea
89+
attributes:
90+
label: Actual Results
91+
description: |
92+
Describe what actually happened.
93+
Paste verbatim command output or any other details.
94+
render: console
95+
placeholder: Helm command output...
96+
validations:
97+
required: true
98+
99+
- type: textarea
100+
attributes:
101+
label: Custom values or parameters?
102+
description: Add any parameter used via `--set` or as a `values.yaml` customization.
103+
validations:
104+
required: false
105+
106+
- type: textarea
107+
attributes:
108+
label: Additional information
109+
description: Tell us anything else you think we should know.
110+
validations:
111+
required: false

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: true
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
name: Feature request
3+
description: Suggest an idea for this project
4+
title: "feature: "
5+
labels: enhancement
6+
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: >
11+
**Thank you for wanting to suggest a feature!**
12+
13+
Please verify first that your idea is not [already requested on
14+
GitHub][issue search].
15+
16+
- type: textarea
17+
attributes:
18+
label: Summary
19+
description: >
20+
Describe the new feature/improvement you would like briefly below.
21+
22+
What's the problem this feature will solve?
23+
What are you trying to do, that you are unable to achieve?
24+
25+
placeholder: >-
26+
The new feature will improve...
27+
validations:
28+
required: true
29+
30+
- type: dropdown
31+
attributes:
32+
label: Issue Type
33+
description: >
34+
Please select the single available option in the drop-down.
35+
36+
options:
37+
- Feature Idea
38+
validations:
39+
required: true

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Description
2+
3+
<!--
4+
Please include a summary of the change, provide a justification and which issue is fixed.
5+
-->
6+
7+
## Type of change
8+
9+
- [ ] A bug fix (PR prefix `fix`)
10+
- [ ] A new feature (PR prefix `feat`)
11+
- [ ] A code change that neither fixes a bug nor adds a feature (PR prefix `refactor`)
12+
- [ ] Adding missing tests or correcting existing tests (PR prefix `test`)
13+
- [ ] Changes that do not affect the meaning of the code like white-spaces, formatting, missing semi-colons, etc. (PR prefix `style`)
14+
- [ ] Changes to our CI configuration files and scripts (PR prefix `ci`)
15+
- [ ] Documentation only changes (PR prefix `docs`)
16+
17+
## How Has This Been Tested?
18+
19+
<!--
20+
Please describe the tests that you ran to verify your changes.
21+
-->

0 commit comments

Comments
 (0)