Skip to content

Commit

Permalink
docs: address PR feedback
Browse files Browse the repository at this point in the history
  • Loading branch information
alessfg committed Aug 2, 2023
1 parent 8902393 commit 87c3891
Show file tree
Hide file tree
Showing 5 changed files with 13 additions and 7 deletions.
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,9 @@ A clear and concise description of what you expected to happen.

### Your environment

- Version/release of this project or specific commit
- Version/release of Docker and NGINX
- Target deployment platform
- Version/release of Docker and method of installation (e.g. Docker Desktop / Docker Server)
- Version/tag of the NGINX Docker image (e.g. `nginx:alpine`)
- Target deployment platform (e.g. OpenShift / Kubernetes / Docker Compose / etc...)

### Additional context

Expand Down
4 changes: 2 additions & 2 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ Describe the use case and detail of the change. If this PR addresses an issue on

### Checklist

Before creating a PR, run through this checklist and mark each as complete.

Before creating a PR, run through this checklist and mark each as complete:
- [ ] I have read the [`CONTRIBUTING`](https://github.com/nginxinc/docker-nginx/blob/master/CONTRIBUTING.md) document
- [ ] I have run `./update.sh` and ensured all entrypoint/Dockerfile template changes have been applied to the relevant image entrypoint scripts & Dockerfiles
- [ ] If applicable, I have added tests that prove my fix is effective or that my feature works
- [ ] If applicable, I have checked that any relevant tests pass after adding my changes
- [ ] I have updated any relevant documentation
6 changes: 6 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,3 +45,9 @@ Note: if you'd like to implement a new feature, please consider creating a [feat
- Limit the subject line to 72 characters or less.
- Reference issues and pull requests liberally after the subject line.
- 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`).

### Docker Guidelines

- Update any entrypoint scripts via the the scripts contained in the `/entrypoint` directory.
- Update any Dockerfiles via the Dockerfile templates in the root directory (e.g. `Dockerfile-alpine.template`).
- Run the `./update.sh` script to apply all entrypoint/Dockerfile template changes to the relevant image entrypoints & Dockerfiles.
2 changes: 1 addition & 1 deletion SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,6 @@ We advise users to run or update to the most recent release of the NGINX Docker
The F5 Security Incident Response Team (F5 SIRT) has an email alias that makes it easy to report potential security vulnerabilities.

- If you’re an F5 customer with an active support contract, please contact [F5 Technical Support](https://www.f5.com/services/support).
- If you aren’t an F5 customer, please report any potential or current instances of security vulnerabilities with any F5 product to the F5 Security Incident Response Team at <F5SIRT@f5.com>
- If you aren’t an F5 customer, please report any potential or current instances of security vulnerabilities with any F5 product to the F5 Security Incident Response Team at <F5SIRT@f5.com>.

For more information visit [https://www.f5.com/services/support/report-a-vulnerability](https://www.f5.com/services/support/report-a-vulnerability)
2 changes: 1 addition & 1 deletion SUPPORT.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Ask a Question

We use GitHub for tracking bugs and feature requests related to the Docker NGINX image.
We use GitHub for tracking bugs and feature requests related to all the Docker NGINX images (including all variants and container registries).

Don't know how something in this project works? Curious if this project can achieve your desired functionality? Please open an issue on GitHub with the label `question`.

Expand Down

0 comments on commit 87c3891

Please sign in to comment.