Skip to content

Commit fb78d51

Browse files
terraform-docs: automated action
1 parent 14f0eef commit fb78d51

File tree

8 files changed

+405
-26
lines changed

8 files changed

+405
-26
lines changed

.github/CODE_OF_CONDUCT.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
6+
7+
## Our Standards
8+
9+
Examples of behavior that contributes to creating a positive environment include:
10+
11+
* Using welcoming and inclusive language
12+
* Being respectful of differing viewpoints and experiences
13+
* Gracefully accepting constructive criticism
14+
* Focusing on what is best for the community
15+
* Showing empathy towards other community members
16+
17+
Examples of unacceptable behavior by participants include:
18+
19+
* The use of sexualized language or imagery and unwelcome sexual attention or advances
20+
* Trolling, insulting/derogatory comments, and personal or political attacks
21+
* Public or private harassment
22+
* Publishing others' private information, such as a physical or electronic address, without explicit permission
23+
* Other conduct which could reasonably be considered inappropriate in a professional setting
24+
25+
## Our Responsibilities
26+
27+
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
28+
29+
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
30+
31+
## Scope
32+
33+
This Code of Conduct applies within all project spaces, and it also applies when an individual is representing the project or its community in public spaces. Examples of representing a project or community include using an official project email address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
34+
35+
## Enforcement
36+
37+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project maintainer using any of the [private contact addresses](https://github.com/ventx/terraform-aws-stackx-objectstorage#support). All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
38+
39+
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
40+
41+
## Attribution
42+
43+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 1.4, available at <https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>
44+
45+
For answers to common questions about this code of conduct, see <https://www.contributor-covenant.org/faq>

.github/CONTRIBUTING.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# Contributing
2+
3+
When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
4+
Please note we have a [code of conduct](CODE_OF_CONDUCT.md), please follow it in all your interactions with the project.
5+
6+
## Development environment setup
7+
8+
To set up a development environment, please follow these steps:
9+
10+
1. Clone the repo
11+
12+
```sh
13+
git clone https://github.com/ventx/terraform-aws-stackx-objectstorage
14+
```
15+
16+
2. Install [pre-commit](https://pre-commit.com) hooks
17+
18+
```sh
19+
pre-commit install
20+
```
21+
22+
3. Install tools with asdf:
23+
24+
```sh
25+
asdf install
26+
```
27+
28+
4. TODO
29+
30+
31+
## Issues and feature requests
32+
33+
You've found a bug in the source code, a mistake in the documentation or maybe you'd like a new feature? You can help us by [submitting an issue on GitHub](https://github.com/ventx/terraform-aws-stackx-objectstorage/issues). Before you create an issue, make sure to search the issue archive -- your issue may have already been addressed!
34+
35+
Please try to create bug reports that are:
36+
37+
- _Reproducible._ Include steps to reproduce the problem.
38+
- _Specific._ Include as much detail as possible: which version, what environment, etc.
39+
- _Unique._ Do not duplicate existing opened issues.
40+
- _Scoped to a Single Bug._ One bug per report.
41+
42+
**Even better: Submit a pull request with a fix or new feature!**
43+
44+
### How to submit a Pull Request
45+
46+
1. Search our repository for open or closed
47+
[Pull Requests](https://github.com/ventx/terraform-aws-stackx-objectstorage/pulls)
48+
that relate to your submission. You don't want to duplicate effort.
49+
2. Fork the project
50+
3. Create your feature branch (`git checkout -b feat/amazing_feature`)
51+
4. Commit your changes (`git commit -m 'feat: add amazing_feature'`) -- ℹ️ terraform-aws-stackx-objectstorage uses [conventional commits](https://www.conventionalcommits.org), so please follow the specification in your commit messages.
52+
5. Push to the branch (`git push origin feat/amazing_feature`)
53+
6. [Open a Pull Request](https://github.com/ventx/terraform-aws-stackx-objectstorage/compare?expand=1)

.github/SECURITY.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Security Policy
2+
3+
## Reporting a Vulnerability
4+
5+
If there are any vulnerabilities in **terraform-aws-stackx-objectstorage**, don't hesitate to _report them_.
6+
7+
1. Use any of the [private contact addresses](https://github.com/ventx/terraform-aws-stackx-objectstorage#support).
8+
2. Describe the vulnerability.
9+
10+
If you have a fix, that is most welcome -- please attach or summarize it in your message!
11+
12+
3. We will evaluate the vulnerability and, if necessary, release a fix or mitigating steps to address it. We will contact you to let you know the outcome, and will credit you in the report.
13+
14+
Please **do not disclose the vulnerability publicly** until a fix is released!
15+
16+
4. Once we have either a) published a fix, or b) declined to address the vulnerability for whatever reason, you are free to publicly disclose it.

0 commit comments

Comments
 (0)