Skip to content

Commit a7e7d1e

Browse files
apoorva-marisomaradhyaapoorva-marisomaradhya
authored
ATEAM-11373: Improve user docs [SKIP CI] (#42)
1 parent 498537e commit a7e7d1e

File tree

4 files changed

+201
-0
lines changed

4 files changed

+201
-0
lines changed

‎CODE_OF_CONDUCT.md

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

‎CONTRIBUTING.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# Contributing
2+
3+
When contributing to this repository, please first discuss the change you wish to make via issue,
4+
email, or any other method with the owners of this repository before making a change.
5+
6+
Please note we have a [code of conduct](CODE_OF_CONDUCT.md) that we ask you to follow in all your interactions with the project.
7+
8+
**IMPORTANT: Please do not create a Pull Request without creating an issue first.**
9+
10+
*Any change needs to be discussed before proceeding. Failure to do so may result in the rejection of the pull request.*
11+
12+
Thank you for your pull request. Please provide a description above and review
13+
the requirements below.
14+
15+
## Pull Request Process
16+
17+
0. Check out [Pull Request Checklist](#pull-request-checklist), ensure you have fulfilled each step.
18+
1. Check out guidelines below, the project tries to follow these, ensure you have fulfilled them as much as possible.
19+
* [Effective Go](https://golang.org/doc/effective_go.html)
20+
* [Go Code Review Comments](https://github.com/golang/go/wiki/CodeReviewComments)
21+
2. Please ensure the [README](README.md) and [DOCS](./DOCS.md) are up-to-date with details of changes to the command-line interface,
22+
this includes new environment variables, exposed ports, used file locations, and container parameters.
23+
3. **PLEASE ENSURE YOU DO NOT INTRODUCE BREAKING CHANGES.**
24+
4. **PLEASE ENSURE BUG FIXES AND NEW FEATURES INCLUDE TESTS.**
25+
5. Pull requests will be reviewd and merged by the maintainer/code owner.
26+
27+
## Pull Request Checklist
28+
29+
- [x] Read the **CONTRIBUTING** document. (It's checked since you are already here.)
30+
- [ ] Read the [**CODE OF CONDUCT**](CODE_OF_CONDUCT.md) document.
31+
- [ ] Add tests to cover changes under terratest directory.
32+
- [ ] Ensure your code follows the code style of this project.
33+
- [ ] Ensure CI and all other PR checks are green OR
34+
- [ ] Code compiles correctly.
35+
- [ ] Created tests which fail without the change (if possible).
36+
- [ ] All new and existing tests passed.
37+
- [ ] Add your changes to `Unreleased` section of [CHANGELOG](CHANGELOG.md).
38+
- [ ] Improve and update the [README](README.md) (if necessary).
39+
40+
41+
## Release Process
42+
43+
*Only concerns maintainers/code owners*
44+
45+
0. **PLEASE DO NOT INTRODUCE BREAKING CHANGES**
46+
1. Update `README.md`with the latest changes.
47+
2. Increase the version numbers in any examples files and the README.md to the new version that this
48+
the release would represent. The versioning scheme we use is [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/meltwater/terraform-aws-asg-dns-handler/tags).
49+
3. Ensure [CHANGELOG](CHANGELOG.md) is up-to-date with new version changes.
50+
4. Update version references.
51+
52+
53+
54+
## Response Times
55+
56+
**Please note the below timeframes are response windows we strive to meet. Please understand we may not always be able to respond in the exact timeframes outlined below**
57+
- New issues will be reviewed and acknowledged with a message sent to the submitter within two business days
58+
- ***Please ensure all of your pull requests have an associated issue.***
59+
- The ticket will then be groomed and planned as regular sprint work and an estimated timeframe of completion will be communicated to the submitter.
60+
- Once the ticket is complete, a final message will be sent to the submitter letting them know work is complete.
61+
62+
***Please feel free to ping us if you have not received a response after one week***

‎ISSUE_TEMPLATE.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
## Expected Behavior
2+
3+
4+
## Actual Behavior
5+
6+
7+
## Steps to Reproduce the Problem
8+
9+
1.
10+
2.
11+
3.
12+
13+
## Specifications
14+
15+
- Version:
16+
- Platform:
17+
- Subsystem:

‎PULL_REQUEST_TEMPLATE.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
<!--
2+
**IMPORTANT: Please do not create a Pull Request without creating an issue first.**
3+
4+
*Any change needs to be discussed before proceeding. Failure to do so may result in the rejection of the pull request.*
5+
6+
Thank you for your pull request. Please provide a description above and review
7+
the requirements below.
8+
9+
**BUG FIXES AND NEW FEATURES SHOULD INCLUDE TESTS.**
10+
11+
Contributors guide: ./CONTRIBUTING.md
12+
Code of conduct: ./CODE_OF_CONDUCT.md
13+
-->
14+
15+
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our [code of conduct](CODE_OF_CONDUCT.md), and the process for submitting pull requests to us.
16+
17+
Fixes #
18+
19+
## Proposed Changes
20+
<!-- Please briefly list the changes you made here. -->
21+
22+
-
23+
-
24+
-
25+
26+
### Description
27+
28+
<!-- Please explain the changes you made here. -->
29+
30+
### Checklist
31+
32+
<!-- _Please make sure to review and check all of these items:_ -->
33+
34+
<!-- Remove items that do not apply. For completed items, change [ ] to [x]. -->
35+
36+
- [ ] Read the [**CONTRIBUTING**](CONTRIBUTING.md) document.
37+
- [ ] Read the [**CODE OF CONDUCT**](CODE_OF_CONDUCT.md) document.
38+
- [ ] Add tests to cover changes.
39+
- [ ] Ensure your code follows the code style of this project.
40+
- [ ] Ensure CI and all other PR checks are green OR
41+
- [ ] Code compiles correctly.
42+
- [ ] Created tests which fail without the change (if possible).
43+
- [ ] All new and existing tests passed.
44+
- [ ] Add your changes to `Unreleased` section of [CHANGELOG](CHANGELOG.md).
45+
- [ ] Improve and update the [README](README.md) (if necessary).
46+

0 commit comments

Comments
 (0)