Skip to content

Commit 198ae54

Browse files
authored
docs: update community related docs (#234)
1 parent 7f5df74 commit 198ae54

File tree

9 files changed

+141
-148
lines changed

9 files changed

+141
-148
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 27 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,41 @@
11
---
22
name: Bug report
33
about: Create a report to help us improve
4-
4+
title: ""
5+
labels: ""
6+
assignees: ""
57
---
68

7-
**Describe the bug**
9+
### Describe the bug
10+
811
A clear and concise description of what the bug is.
912

10-
**To Reproduce**
13+
### To reproduce
14+
1115
Steps to reproduce the behavior:
12-
1. Start container with x/y arguments
13-
2. View logs on '....'
16+
17+
1. Start container with [...] arguments
18+
2. View output/logs/configuration on [...]
1419
3. See error
1520

16-
**Expected behavior**
21+
### Expected behavior
22+
1723
A clear and concise description of what you expected to happen.
1824

19-
**Your environment**
20-
* Version of the repo - a specific commit or tag
21-
* Version of the container used (if downloaded from Docker Hub or Github)
22-
* S3 backend implementation you are using (AWS, Ceph, NetApp StorageGrid, etc)
23-
* How you are deploying Docker/Stand-alone, etc
24-
* NGINX type (OSS/Plus)
25-
* Authentication method (IAM, IAM with Fargate, IAM with K8S, AWS Credentials, etc)
25+
### Your environment
26+
27+
- Version of the S3 container used (when downloaded from either Docker Hub or the GitHub Container Registry)
28+
- Version of this project or specific commit when building your own S3 container
29+
- Version of NGINX Open Source or NGINX Plus (OSS/Plus)
30+
- Version of NGINX JavaScript
31+
- Target deployment platform for the S3 container
32+
- S3 backend implementation (AWS, Ceph, NetApp StorageGrid, etc...)
33+
- Authentication method (IAM, IAM with Fargate, IAM with K8S, AWS Credentials, etc...)
34+
35+
### Additional context
36+
37+
Add any other context about the problem here.
2638

27-
**Additional context**
28-
Add any other context about the problem here. Any log files you want to share.
39+
### Sensitive Information
2940

30-
**Sensitive Information**
31-
Be sure to redact any sensitive information such as your AWS authentication keys.
41+
Remember to redact any sensitive information such as authentication credentials or license keys.
Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,23 @@
11
---
22
name: Feature request
33
about: Suggest an idea for this project
4-
4+
title: ""
5+
labels: ""
6+
assignees: ""
57
---
68

7-
**Is your feature request related to a problem? Please describe.**
9+
### Is your feature request related to a problem? Please describe
10+
811
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
912

10-
**Describe the solution you'd like**
13+
### Describe the solution you'd like
14+
1115
A clear and concise description of what you want to happen.
1216

13-
**Describe alternatives you've considered**
17+
### Describe alternatives you've considered
18+
1419
A clear and concise description of any alternative solutions or features you've considered.
1520

16-
**Additional context**
17-
Add any other context or screenshots about the feature request here.
21+
### Additional context
22+
23+
Add any other context or screenshots about the feature request here.

.github/pull_request_template.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
### Proposed changes
2+
3+
Describe the use case and detail of the change. If this PR addresses an issue on GitHub, make sure to include a link to that issue using one of the [supported keywords](https://docs.github.com/en/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue) in this PR description (not in the title of the PR).
4+
5+
### Checklist
6+
7+
Before creating a PR, run through this checklist and mark each as complete:
8+
9+
- [ ] I have read the [`contributing guidelines`](/CONTRIBUTING.md).
10+
- [ ] If applicable, I have added tests that prove my fix is effective or that my feature works.
11+
- [ ] If applicable, I have checked that any relevant tests pass after adding my changes.
12+
- [ ] I have updated any relevant documentation (e.g. [`README.md`](/README.md)).

CODE_OF_CONDUCT.md

Lines changed: 31 additions & 82 deletions
Original file line numberDiff line numberDiff line change
@@ -1,129 +1,78 @@
1-
21
# Contributor Covenant Code of Conduct
32

43
## Our Pledge
54

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, religion, or sexual identity
11-
and orientation.
5+
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.
126

13-
We pledge to act and interact in ways that contribute to an open, welcoming,
14-
diverse, inclusive, and healthy community.
7+
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
158

169
## Our Standards
1710

18-
Examples of behavior that contributes to a positive environment for our
19-
community include:
11+
Examples of behavior that contributes to a positive environment for our community include:
2012

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
27-
overall community
13+
- Demonstrating empathy and kindness toward other people.
14+
- Being respectful of differing opinions, viewpoints, and experiences.
15+
- Giving and gracefully accepting constructive feedback.
16+
- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience.
17+
- Focusing on what is best not just for us as individuals, but for the overall community.
2818

2919
Examples of unacceptable behavior include:
3020

31-
* The use of sexualized language or imagery, and sexual attention or
32-
advances of 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
36-
address, without their explicit permission
37-
* Other conduct which could reasonably be considered inappropriate in a
38-
professional setting
21+
- The use of sexualized language or imagery, and sexual attention or advances of any kind.
22+
- Trolling, insulting or derogatory comments, and personal or political attacks.
23+
- Public or private harassment.
24+
- Publishing others' private information, such as a physical or email address, without their explicit permission.
25+
- Other conduct which could reasonably be considered inappropriate in a professional setting.
3926

4027
## Enforcement Responsibilities
4128

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.
29+
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
4630

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.
31+
Community leaders 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, and will communicate reasons for moderation decisions when appropriate.
5132

5233
## Scope
5334

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.
35+
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official email address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
5936

6037
## Enforcement
6138

62-
Instances of abusive, harassing, or otherwise unacceptable behavior may be
63-
reported to the community leaders responsible for enforcement as listed on the
64-
github project page.
65-
All complaints will be reviewed and investigated promptly and fairly.
39+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at <[email protected]>. All complaints will be reviewed and investigated promptly and fairly.
6640

67-
All community leaders are obligated to respect the privacy and security of the
68-
reporter of any incident.
41+
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
6942

7043
## Enforcement Guidelines
7144

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:
45+
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
7446

7547
### 1. Correction
7648

77-
**Community Impact**: Use of inappropriate language or other behavior deemed
78-
unprofessional or unwelcome in the community.
49+
**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
7950

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.
51+
**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
8352

8453
### 2. Warning
8554

86-
**Community Impact**: A violation through a single incident or series
87-
of actions.
55+
**Community Impact**: A violation through a single incident or series of actions.
8856

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
94-
permanent ban.
57+
**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
9558

9659
### 3. Temporary Ban
9760

98-
**Community Impact**: A serious violation of community standards, including
99-
sustained inappropriate behavior.
61+
**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
10062

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.
63+
**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
10664

10765
### 4. Permanent Ban
10866

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.
67+
**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
11268

113-
**Consequence**: A permanent ban from any sort of public interaction within
114-
the community.
69+
**Consequence**: A permanent ban from any sort of public interaction within the community.
11570

11671
## Attribution
11772

118-
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
119-
version 2.0, available at
120-
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
121-
122-
Community Impact Guidelines were inspired by [Mozilla's code of conduct
123-
enforcement ladder](https://github.com/mozilla/diversity).
73+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.1, available at <https://www.contributor-covenant.org/version/2/1/code_of_conduct.html>.
12474

125-
[homepage]: https://www.contributor-covenant.org
75+
Community Impact Guidelines were inspired by
76+
[Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/inclusion).
12677

127-
For answers to common questions about this code of conduct, see the FAQ at
128-
https://www.contributor-covenant.org/faq. Translations are available at
129-
https://www.contributor-covenant.org/translations.
78+
For answers to common questions about this code of conduct, see the FAQ at <https://www.contributor-covenant.org/faq>. Translations are available at <https://www.contributor-covenant.org/translations>.

CONTRIBUTING.md

Lines changed: 30 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,51 @@
11
# Contributing Guidelines
22

3-
The following is a set of guidelines for contributing. We really appreciate that you are considering contributing!
3+
The following is a set of guidelines for contributing to this project. We really appreciate that you are considering contributing!
44

55
#### Table Of Contents
66

7-
[Ask a Question](#ask-a-question)
7+
[Getting Started](#getting-started)
88

99
[Contributing](#contributing)
1010

11-
[Code of Conduct](CODE_OF_CONDUCT.md)
11+
[Code Guidelines](#code-guidelines)
1212

13-
## Ask a Question
13+
[Code of Conduct](/CODE_OF_CONDUCT.md)
1414

15-
Please ask your question on github using discussions.
15+
## Getting Started
16+
17+
Follow the instructions on the README's [Getting Started Guide](/README.md#Getting-Started) section to get this project up and running.
18+
19+
<!-- ### Project Structure (OPTIONAL) -->
1620

1721
## Contributing
1822

1923
### Report a Bug
2024

21-
To report a bug, open an issue on GitHub with the label `bug` using the available bug report issue template. Please ensure the issue has not already been reported.
25+
To report a bug, open an issue on GitHub with the label `bug` using the available bug report issue template. Please ensure the bug has not already been reported. **If the bug is a potential security vulnerability, please report it using our [security policy](/SECURITY.md).**
2226

23-
### Suggest an Enhancement
27+
### Suggest a Feature or Enhancement
2428

25-
To suggest an enhancement, please create an issue on GitHub with the label `enhancement` using the available feature issue template.
29+
To suggest a feature or enhancement, please create an issue on GitHub with the label `enhancement` using the available [feature request template](/.github/feature_request_template.md). Please ensure the feature or enhancement has not already been suggested.
2630

2731
### Open a Pull Request
2832

29-
* Fork the repo, create a branch, submit a PR when your changes are tested and ready for review.
33+
- Fork the repo, create a branch, implement your changes, add any relevant tests, submit a PR when your changes are **tested** and ready for review.
34+
- Fill in [our pull request template](/.github/pull_request_template.md).
35+
36+
**Note:** If you'd like to implement a new feature, please consider creating a [feature request issue](/.github/feature_request_template.md) first to start a discussion about the feature.
37+
38+
## Code Guidelines
39+
40+
<!-- ### Go/Python/Bash/etc... Guidelines (OPTIONAL) -->
41+
42+
### Git Guidelines
3043

31-
Note: if you’d like to implement a new feature, please consider creating a feature request issue first to start a discussion about the feature.
44+
- Keep a clean, concise and meaningful git commit history on your branch (within reason), rebasing locally and squashing before submitting a PR.
45+
- If possible and/or relevant, use the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) format when writing a commit message, so that changelogs can be automatically generated.
46+
- Follow the guidelines of writing a good commit message as described here <https://chris.beams.io/posts/git-commit/> and summarized in the next few points:
47+
- In the subject line, use the present tense ("Add feature" not "Added feature").
48+
- In the subject line, use the imperative mood ("Move cursor to..." not "Moves cursor to...").
49+
- Limit the subject line to 72 characters or less.
50+
- Reference issues and pull requests liberally after the subject line.
51+
- Add more detailed description in the body of the git message (`git commit -a` to give you more space and time in your text editor to write a good message instead of `git commit -am`).

LICENSE.txt renamed to LICENSE

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
21
Apache License
32
Version 2.0, January 2004
43
http://www.apache.org/licenses/

0 commit comments

Comments
 (0)