Skip to content

Commit e8ce5fc

Browse files
committed
feat: addon refactor
1 parent 5cfe488 commit e8ce5fc

26 files changed

+1181
-326
lines changed

.github/CODE_OF_CONDUCT.md

+133
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+
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

+30
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. Update the README.md with details of changes including example hcl blocks and [example files](./examples) if appropriate.
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. The terraform-aws-vpc maintainers take care of updating the CHANGELOG as they merge.
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 `terraform_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

.github/ISSUE_TEMPLATE/bug_report.yml

+108
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
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 wanting to report 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 teraform module from the main branch on GitHub, Y
24+
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: >
33+
Please select the single available option in the drop-down.
34+
35+
<details>
36+
<summary>
37+
<em>Why?</em>
38+
</summary>
39+
40+
We would do it by ourselves but unfortunatelly, the curent
41+
edition of GitHub Issue Forms Alpha does not support this yet 🤷
42+
43+
44+
_We will make it easier in the future, once GitHub
45+
supports dropdown defaults. Promise!_
46+
47+
</details>
48+
options:
49+
- Bug Report
50+
validations:
51+
required: true
52+
53+
- type: textarea
54+
attributes:
55+
label: Terraform Version
56+
description: >-
57+
Paste verbatim output from `terraform --version` below, under
58+
the prompt line. Please don't wrap it with tripple backticks — your
59+
whole input will be turned into a code snippet automatically.
60+
render: console
61+
placeholder: |
62+
$ terraform --version
63+
Terraform v1.1.4
64+
on linux_amd64
65+
+ provider registry.terraform.io/cloudposse/utils v0.17.23
66+
+ provider registry.terraform.io/hashicorp/aws v4.13.0
67+
+ provider registry.terraform.io/hashicorp/helm v2.5.1
68+
+ provider registry.terraform.io/hashicorp/kubernetes v2.11.0
69+
validations:
70+
required: true
71+
72+
- type: textarea
73+
attributes:
74+
label: Steps to Reproduce
75+
description: |
76+
Describe exactly how to reproduce the problem, using a minimal test-case.
77+
78+
**HINT:** You can paste https://gist.github.com links for larger files.
79+
value: |
80+
<!--- Paste example terraform code between quotes below -->
81+
```hcl (paste below)
82+
83+
```
84+
validations:
85+
required: true
86+
87+
- type: textarea
88+
attributes:
89+
label: Expected Results
90+
description: >-
91+
Describe what you expected to happen when running the steps above.
92+
placeholder: >-
93+
I expected X to happen because I assumed Y.
94+
validations:
95+
required: true
96+
97+
- type: textarea
98+
attributes:
99+
label: Actual Results
100+
description: |
101+
Describe what actually happened.
102+
103+
Paste verbatim command output and don't wrap it with tripple backticks — your
104+
whole input will be turned into a code snippet automatically.
105+
render: console
106+
placeholder: Terrafom command output...
107+
validations:
108+
required: true

.github/ISSUE_TEMPLATE/config.yml

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: true
+39
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

+21
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+
-->

.github/RELEASE_DRAFTER.yml

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
name-template: 'v$RESOLVED_VERSION'
2+
tag-template: 'v$RESOLVED_VERSION'
3+
categories:
4+
- title: 'Features'
5+
labels:
6+
- 'feature'
7+
- 'enhancement'
8+
- title: 'Bug Fixes'
9+
labels:
10+
- 'fix'
11+
- 'bugfix'
12+
- 'bug'
13+
- title: 'Documentation'
14+
label: 'documentation'
15+
change-template: '- $TITLE, by @$AUTHOR (#$NUMBER)'
16+
template: |
17+
# What's changed
18+
19+
$CHANGES

0 commit comments

Comments
 (0)