Skip to content

Commit a42fb99

Browse files
alessfgalessfg
committed
Add contribution guidelines & templates
1 parent d6650c3 commit a42fb99

File tree

8 files changed

+257
-2
lines changed

8 files changed

+257
-2
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
name: Bug report
3+
about: Create a bug report to help us improve
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
---
8+
### Describe the bug
9+
10+
A clear and concise description of what the bug is.
11+
12+
### To reproduce
13+
14+
Steps to reproduce the behavior:
15+
16+
1. Deploy NGINX Unprivileged Docker image
17+
2. View output/logs/configuration on '...'
18+
3. See error
19+
20+
### Expected behavior
21+
22+
A clear and concise description of what you expected to happen.
23+
24+
### Your environment
25+
26+
- Version of Docker
27+
- Version of the NGINX Unprivileged Docker image
28+
- Target deployment environment/platform
29+
30+
### Additional context
31+
32+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
---
8+
### Is your feature request related to a problem? Please describe
9+
10+
A clear and concise description of what the problem is. Ex. I'm always frustrated when ...
11+
12+
### Describe the solution you'd like
13+
14+
A clear and concise description of what you want to happen.
15+
16+
### Describe alternatives you've considered
17+
18+
A clear and concise description of any alternative solutions or features you've considered.
19+
20+
### Additional context
21+
22+
Add any other context or screenshots about the feature request here.

‎.github/ISSUE_TEMPLATE/security_report.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
name: Security report
3+
about: Create a security report to help us improve
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
---
8+
### Describe the bug
9+
10+
A clear and concise description of what the security vulnerability is.
11+
12+
### To reproduce
13+
14+
Steps to reproduce the behavior:
15+
16+
1. Deploy NGINX Unprivileged Docker image
17+
2. View output/logs/configuration on '...'
18+
3. See error
19+
20+
### Your environment
21+
22+
- Version of the NGINX Unprivileged Docker image
23+
- Target deployment environment/platform
24+
25+
### Additional context
26+
27+
Does this security vulnerability relate to one of the NGINX libraries specified in the [`SECURITY`](https://github.com/nginxinc/docker-nginx-unprivileged/blob/main/.github/SECURITY.md) doc?

‎.github/SECURITY.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Security Policy
2+
3+
## Reporting a Vulnerability
4+
5+
If you find a security vulnerability that directly affects the Docker NGINX Unprivileged image we encourage you open an issue detailing the security vulnerability. Do note that only vulnerabilities related to direct NGINX library dependencies will be considered. For reference, these are:
6+
7+
* For Debian:
8+
* `libc6`
9+
* `libcrypt1`
10+
* `libpcre2`
11+
* `libssl`
12+
* `zlib1g`
13+
14+
* For Alpine Linux:
15+
* `libc`
16+
* `libcrypto`
17+
* `libpcre2`
18+
* `libssl`
19+
* `libz`

‎.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) here in this 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`](https://github.com/nginxinc/docker-nginx-unprivileged/blob/main/CONTRIBUTING.md) document.
10+
- [ ] I have tested that the NGINX Unprivileged Docker images build correctly on all supported platforms (check out the [`README`](https://github.com/nginxinc/docker-nginx-unprivileged/blob/main/README.md) for more details).
11+
- [ ] I have deployed the NGINX Unprivileged Docker images on an unprivileged environment and checked that they run correctly.
12+
- [ ] I have updated any relevant documentation ([`README`](https://github.com/nginxinc/docker-nginx-unprivileged/blob/main/README.md))

‎CODE_OF_CONDUCT.md‎

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
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](https://www.contributor-covenant.org), version 1.4,
71+
available at <https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>
72+
73+
For answers to common questions about this code of conduct, see
74+
<https://www.contributor-covenant.org/faq>

‎CONTRIBUTING.md‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
# Contributing Guidelines
2+
3+
The following is a set of guidelines for contributing to the Docker Unprivileged NGINX image. We really appreciate that you are considering contributing!
4+
5+
#### Table Of Contents
6+
7+
[Ask a Question](#ask-a-question)
8+
9+
[Getting Started](#getting-started)
10+
11+
[Contributing](#contributing)
12+
13+
[Code Guidelines](#code-guidelines)
14+
15+
* [Git Guidelines](#git-guidelines)
16+
* [Ansible Guidelines](#ansible-guidelines)
17+
18+
[Code of Conduct](https://github.com/nginxinc/docker-nginx-unprivileged/blob/main/CODE_OF_CONDUCT.md)
19+
20+
## Ask a Question
21+
22+
Don't know how something works? Curious if the role can achieve your desired functionality? Please open an Issue on GitHub with the label `question`.
23+
24+
### Project Overview
25+
26+
* The Docker Unprivileged NGINX repository is a mirror image of the [Docker NGINX image](https://github.com/nginxinc/docker-nginx). Changes have been made in order to support running NGINX in an unprivileged environment.
27+
* New Docker Unprivileged NGINX images are built on a weekly basis using GitHub actions.
28+
29+
## Contributing
30+
31+
### Report a Bug
32+
33+
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.
34+
35+
### Report a Security vulnerability
36+
37+
To report a secuirty vulnerability, open an issue on GitHub with the label `security` using the available security report issue template. Please ensure the security vulnerability directly impacts one of the NGINX dependencies listed in the [`SECURITY`](https://github.com/nginxinc/docker-nginx-unprivileged/blob/main/.github/SECURITY.md) doc.
38+
39+
### Suggest a Feature or Enhancement
40+
41+
To suggest an enhancement, please create an issue on GitHub with the label `feature` or `enhancement` using the available feature issue template.
42+
43+
### Open a Pull Request
44+
45+
* Fork the repo, create a branch, implement your changes, test that the corresponding Docker images can be built and run as intended, and submit a PR when your changes are **tested** and ready for review.
46+
* Fill in [our pull request template](https://github.com/nginxinc/docker-nginx-unprivileged/blob/main/.github/pull_request_template.md).
47+
48+
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.
49+
50+
## Code Guidelines
51+
52+
### Docker NGINX Unprivileged Guidelines
53+
54+
Given this repository is a mirror image of the upstream [Docker NGINX image](https://github.com/nginxinc/docker-nginx), only two types of PRs will be considered:
55+
56+
1. PRs that incorporate changes made to upstream images (e.g. there's a new NGINX release).
57+
2. PRs that add a critical feature or a nice-to-have enhancement for running these images on an unprivileged environment (e.g. allowing users specify the UID/GUI of the image user).
58+
59+
### Git Guidelines
60+
61+
* Keep a clean, concise and meaningful git commit history on your branch (within reason), rebasing locally and squashing before submitting a PR.
62+
* Follow the guidelines of writing a good commit message as described here <https://chris.beams.io/posts/git-commit/> and summarised in the next few points:
63+
* In the subject line, use the present tense ("Add feature" not "Added feature").
64+
* In the subject line, use the imperative mood ("Move cursor to..." not "Moves cursor to...").
65+
* Limit the subject line to 72 characters or less.
66+
* Reference issues and pull requests liberally after the subject line.
67+
* 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`).

‎README.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ This Dockerfile creates an NGINX Docker image that runs NGINX as a non root, unp
77
* The default NGINX PID has been moved from `/var/run/nginx.pid` to `/tmp/nginx.pid`.
88
* Change `*_temp_path` variables to `/tmp/*`.
99

10-
Docker Hub images are built for the `amd64`, `arm32v5` (for Debian), `arm32v6` (for Alpine), `arm32v7`, `arm64v8`, `i386`, `mips64le` (for Debian), `ppc64le` and `s390x` architectures and can be found at <https://hub.docker.com/r/nginxinc/nginx-unprivileged>.
10+
Docker Hub images are built on a weekly basis for the `amd64`, `arm32v5` (for Debian), `arm32v6` (for Alpine), `arm32v7`, `arm64v8`, `i386`, `mips64le` (for Debian), `ppc64le` and `s390x` architectures and can be found at <https://hub.docker.com/r/nginxinc/nginx-unprivileged>.
1111

12-
**Note:** Issues related to security vulnerabilities will be promptly closed unless they are accompanied by a solid reasoning as to why the vulnerability poses a real security threat to this image.
12+
Check out the [docs](https://hub.docker.com/_/nginx) for the upstream Docker NGINX image for a detailed explanation of how to use this image.
13+
14+
**Note:** Issues related to security vulnerabilities will be promptly closed unless they are accompanied by a solid reasoning as to why the vulnerability poses a real security threat to this image. Check out the [`SECURITY`](https://github.com/nginxinc/docker-nginx-unprivileged/blob/main/.github/SECURITY.md) doc for more details.

0 commit comments

Comments
 (0)