Skip to content

feat: Update issue and overview process documentation #1446

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 20, 2025
+10 −0
Merged

feat: Update issue and overview process documentation #1446

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1281753
feat: Update issue and overview process documentation
ADubhlaoich Nov 14, 2025
e545b00
Merge branch 'main' into docs/issue-updates
JTorreG Nov 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
0 .github/ISSUE_TEMPLATE/3-general_request.yml → .github/ISSUE_TEMPLATE/1-general_request.yml
View file
Open in desktop
File renamed without changes.
0 .github/ISSUE_TEMPLATE/1-idea_suggestion.yml → .github/ISSUE_TEMPLATE/3-idea_suggestion.yml
View file
Open in desktop
File renamed without changes.
1 change: 1 addition & 0 deletions documentation/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ If you're interested in contributing to the [NGINX documentation website](https:
- [Using include files](/documentation/include-files.md)
- [Contributing closed content](/documentation/closed-contributions.md)
- [Review deprecated content](/documentation/deprecated-content.md)
- [nginx.org content](/documentation/nginx-org-source.md)

## Writing guidance

Expand Down
9 changes: 9 additions & 0 deletions documentation/prepare-issue.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,15 @@ We strive to make each issue a single source of truth: as a result, each ticket

This document exists to explain concepts you may be unfamiliar with, and provide examples of the types and amount of detail preferred.

Here are examples of well-formed issues using the templates:

- [\[Request\]: Clarify NGINX configuration limitations for F5 WAF for NGINX](https://github.com/nginx/documentation/issues/1436)
- [\[Story\]: Replace examples of sensitive values with explicit placeholders](https://github.com/nginx/documentation/issues/1363)

*General request* and *Bug report* are the most common issue types, with *Documentation idea* available for conceptual improvements.

The *User story* and *Content release plans* are largely for maintainer use, though we do have [guidance for user stories](#user-stories-and-acceptance-criteria) in this document.

## Use active voice

Much like writing user-facing documentation, we prefer [active voice](https://developers.google.com/tech-writing/one/active-voice) when describing an issue.
Expand Down
Loading