generated from nginx/template-repository
-
Notifications
You must be signed in to change notification settings - Fork 121
feat: Update issue templates & process docs #1287
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.
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
Changes from all commits
Commits
Show all changes
25 commits
Select commit
Hold shift + click to select a range
c888768
feat: Update issue templates & process docs
ADubhlaoich 76e23f5
fix: Incorrect attribute nesting
ADubhlaoich 986fb6f
Merge branch 'main' into docs/request-template-guidance
ADubhlaoich 4861041
fix: test
ADubhlaoich dfc0094
feat: Unhide other sections
ADubhlaoich 50dbb09
fix: Remove unnecessary IDs, nest last item
ADubhlaoich 34a70d8
feat: Rename existing templates, update first
ADubhlaoich 88a67c5
fix: Syntax error caused by colon
ADubhlaoich 30c3b10
fix: Remove unnecessary lines
ADubhlaoich f36097e
fix: Needless nesting
ADubhlaoich 84473dc
feat: Update templates
ADubhlaoich 6dea358
feat: Finish converting issue templates to forms
ADubhlaoich b1bb124
fix: Template issues
ADubhlaoich fd350bf
fix: Attempt to fix template
ADubhlaoich b0f0bbc
fix: Update story task template
ADubhlaoich 7e2ca49
feat: Add preparing issue documentation
ADubhlaoich d5c544e
Merge branch 'main' into docs/request-template-guidance
ADubhlaoich 7dd4541
Merge branch 'main' into docs/request-template-guidance
ADubhlaoich cffdd81
Update documentation/prepare-issue.md
ADubhlaoich a72f8fc
Update documentation/prepare-issue.md
ADubhlaoich 73fa3a3
Merge branch 'main' into docs/request-template-guidance
ADubhlaoich f868a73
feat: Restructure doc, add note on active voice
ADubhlaoich 570548e
Apply suggestions from code review
ADubhlaoich 83ea754
Merge branch 'main' into docs/request-template-guidance
ADubhlaoich 3804c49
Apply suggestions from code review
ADubhlaoich File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| name: Documentation idea | ||
| description: Suggest an idea for improving documentation | ||
| title: "[Idea]: " | ||
| body: | ||
| - type: textarea | ||
| attributes: | ||
| label: What is your idea for improving documentation? | ||
| description: Describe your idea with as much information as possible. | ||
| validations: | ||
| required: true | ||
| - type: dropdown | ||
| attributes: | ||
| label: Which product or products does this request relate to? | ||
| multiple: true | ||
| options: | ||
| - F5 DoS for NGINX | ||
| - F5 WAF for NGINX | ||
| - NGINX Agent | ||
| - NGINXaaS for Azure | ||
| - NGINXaaS for Google Cloud | ||
| - NGINX Gateway Fabric | ||
| - NGINX Ingress Controller | ||
| - NGINX Instance Manager | ||
| - NGINX One Console | ||
| - NGINX Plus | ||
| - Other | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| attributes: | ||
| label: Is this idea related to a larger problem? | ||
| description: If you have identified multiple related issues, it might be a design pattern problem. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| attributes: | ||
| label: What alternative ways are there to implement your idea? | ||
| description: There are often multiple ways to something - context is important. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| attributes: | ||
| label: Any additional information | ||
| description: Add any remaining detail for this idea not covered by the above questions. | ||
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| name: Bug report | ||
| description: Report an issue with our documentation | ||
| title: "[Bug]: " | ||
| body: | ||
| - type: textarea | ||
| attributes: | ||
| label: Describe the bug you have identified | ||
| description: Explain the problem with as much detail as possible. | ||
| validations: | ||
| required: true | ||
| - type: dropdown | ||
| attributes: | ||
| label: Which product or products does this request relate to? | ||
| multiple: true | ||
| options: | ||
| - F5 DoS for NGINX | ||
| - F5 WAF for NGINX | ||
| - NGINX Agent | ||
| - NGINXaaS for Azure | ||
ADubhlaoich marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| - NGINXaaS for Google Cloud | ||
| - NGINX Gateway Fabric | ||
| - NGINX Ingress Controller | ||
| - NGINX Instance Manager | ||
| - NGINX One Console | ||
| - NGINX Plus | ||
| - Other | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| attributes: | ||
| label: Steps to reproduce the bug | ||
| description: Describe the where the issue occurs. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| attributes: | ||
| label: What is the expected or desired behaviour? | ||
| description: Describe what you expected to happen instead of the bug. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| attributes: | ||
| label: What environments or versions does this bug affect? | ||
| description: Describe the contexts which this bug seems to occur. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| attributes: | ||
| label: Any additional information | ||
| description: Add any remaining detail for this idea not covered by the above questions. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| name: General request | ||
| description: Make a general documentation request. | ||
| title: "[Request]: " | ||
| body: | ||
| - type: textarea | ||
| attributes: | ||
| label: What would you like the documentation team to work on? | ||
| description: Please describe your request with as much detail as possible. | ||
| validations: | ||
| required: true | ||
| - type: dropdown | ||
| attributes: | ||
| label: Which product or products does this request relate to? | ||
| multiple: true | ||
| options: | ||
| - F5 DoS for NGINX | ||
| - F5 WAF for NGINX | ||
| - NGINX Agent | ||
| - NGINXaaS for Azure | ||
ADubhlaoich marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| - NGINXaaS for Google Cloud | ||
| - NGINX Gateway Fabric | ||
| - NGINX Ingress Controller | ||
| - NGINX Instance Manager | ||
| - NGINX One Console | ||
| - NGINX Plus | ||
| - Other | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| attributes: | ||
| label: Who is the person directly responsible for initiating this request? | ||
| description: Name the specific person that made this request. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| attributes: | ||
| label: Is this request part of a larger initiative or project? | ||
| description: If it is, name the project the request relates to. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| attributes: | ||
| label: Are there important constraints for this request? | ||
| description: If the constraints are particularly complex, you may wish to organise a meeting before filing a request. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| attributes: | ||
| label: Does this request have a due date? | ||
| description: You should name any specific date or milestones (Such as "Q3") you have in mind for this request, and any dependencies or blockers affecting it. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| attributes: | ||
| label: Any additional information | ||
| description: Add any remaining detail for this request not covered by the above questions. | ||
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| name: User story | ||
| description: This template is for a single story, encompassing a single work item for completion | ||
| title: "[Story]: " | ||
| body: | ||
| - type: textarea | ||
| attributes: | ||
| label: Overview | ||
| description: Use this section to write user stories. | ||
| placeholder: As a user, I want thing, So I can action. | ||
| validations: | ||
| required: true | ||
| - type: dropdown | ||
| attributes: | ||
| label: Which product or products does this request relate to? | ||
| multiple: true | ||
| options: | ||
| - F5 DoS for NGINX | ||
| - F5 WAF for NGINX | ||
| - NGINX Agent | ||
| - NGINXaaS for Azure | ||
ADubhlaoich marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| - NGINXaaS for Google Cloud | ||
| - NGINX Gateway Fabric | ||
| - NGINX Ingress Controller | ||
| - NGINX Instance Manager | ||
| - NGINX One Console | ||
| - NGINX Plus | ||
| - Other | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| attributes: | ||
| label: Description | ||
| description: Add the finer details of what this task involves and is trying to accomplish. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| attributes: | ||
| label: Acceptance criteria | ||
| description: Acceptance criteria are written from a user perspective, and should map to the user stories. | ||
| validations: | ||
| required: true | ||
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.