ISSUE TEMPLATE: update issue templates to include comments instead of inline text for instructions (#16313)

* Update bug_report.md
* Update feature_request.md
* Update ui_issues.md
* Update pull_request_template.md
This commit is contained in:
David Yu 2023-02-17 11:46:31 -08:00 committed by GitHub
parent b3c26ebcf7
commit 9027a9629d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 82 additions and 4 deletions

View File

@ -4,20 +4,34 @@ about: You're experiencing an issue with Consul that is different than the docum
--- ---
<!--
When filing a bug, please include the following headings if possible. Any example text in this template can be deleted. When filing a bug, please include the following headings if possible. Any example text in this template can be deleted.
-->
#### Overview of the Issue #### Overview of the Issue
A paragraph or two about the issue you're experiencing. <!--
Please provide a paragraph or two about the issue you're experiencing.
-->
---
#### Reproduction Steps #### Reproduction Steps
<!-- Please provide steps to reproduce the bug, without any details it would
Steps to reproduce this issue, eg: Steps to reproduce this issue, eg:
1. Create a cluster with n client nodes n and n server nodes 1. Create a cluster with n client nodes n and n server nodes
1. Run `curl ...` 1. Run `curl ...`
1. View error 1. View error
-->
### Consul info for both Client and Server ### Consul info for both Client and Server
@ -51,8 +65,18 @@ Server agent HCL config
### Operating system and Environment details ### Operating system and Environment details
<!--
OS, Architecture, and any other information you can provide about the environment. OS, Architecture, and any other information you can provide about the environment.
-->
### Log Fragments ### Log Fragments
<!--
Please provide log file excerpts using the finest log level possible (i.e. DEBUG, TRACE).
-->
Include appropriate Client or Server log fragments. If the log is longer than a few dozen lines, please include the URL to the [gist](https://gist.github.com/) of the log instead of posting it in the issue. Use `-log-level=TRACE` on the client and server to capture the maximum log detail. Include appropriate Client or Server log fragments. If the log is longer than a few dozen lines, please include the URL to the [gist](https://gist.github.com/) of the log instead of posting it in the issue. Use `-log-level=TRACE` on the client and server to capture the maximum log detail.

View File

@ -4,12 +4,24 @@ about: If you have something you think Consul could improve or add support for.
--- ---
<!---
Please search the existing issues for relevant feature requests, and use the reaction feature (https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to add upvotes to pre-existing requests. Please search the existing issues for relevant feature requests, and use the reaction feature (https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to add upvotes to pre-existing requests.
--->
#### Feature Description #### Feature Description
<!---
A written overview of the feature. A written overview of the feature.
--->
#### Use Case(s) #### Use Case(s)
Any relevant use-cases that you see. <!---
Please describe the use case for this feature (i.e. Service Mesh, Service Discovery, KV, API Gateway).
-->

View File

@ -4,41 +4,68 @@ about: You have usage feedback for the browser based UI
--- ---
<!---
When filing a bug, please include the following headings if possible. Any example text in this template can be deleted. When filing a bug, please include the following headings if possible. Any example text in this template can be deleted.
--->
### Overview of the Issue ### Overview of the Issue
A paragraph or two about the issue you're experiencing / suggestion for <!---
Please provide a paragraph or two about the issue you're experiencing / suggestion for
improvement. improvement.
--->
### Reproduction Steps ### Reproduction Steps
<!---
Steps to reproduce this issue/view the area for improvement, eg: Steps to reproduce this issue/view the area for improvement, eg:
1. Visit the UI page at `/ui/services` 1. Visit the UI page at `/ui/services`
1. Click .... then click...etc. 1. Click .... then click...etc.
1. View error/area. 1. View error/area.
--->
### Describe the solution you'd like ### Describe the solution you'd like
<!---
If this is an improvement rather than a bug, a clear and concise description If this is an improvement rather than a bug, a clear and concise description
of what you want to happen. How have you seen this problem solved in other of what you want to happen. How have you seen this problem solved in other
UIs? UIs?
--->
### Consul Version ### Consul Version
<!---
This can be found either in the footer of the UI (Consul versions pre 1.10) or This can be found either in the footer of the UI (Consul versions pre 1.10) or
at the top of the help menu that is in the top right side of the UI. at the top of the help menu that is in the top right side of the UI.
--->
### Browser and Operating system details ### Browser and Operating system details
<!---
Browser, Browser Version, OS, and any other information you can provide about the environment that may be relevant. Browser, Browser Version, OS, and any other information you can provide about the environment that may be relevant.
--->
### Screengrabs / Web Inspector logs ### Screengrabs / Web Inspector logs
<!---
If you think it's worthwhile, include appropriate screengrabs showing the If you think it's worthwhile, include appropriate screengrabs showing the
error/area for improvement. Try to include the URL bar of the browser so we error/area for improvement. Try to include the URL bar of the browser so we
can see the current URL where the error manifests. Please be careful to can see the current URL where the error manifests. Please be careful to
obfuscate any sensitive information either in the URL or in the browser page obfuscate any sensitive information either in the URL or in the browser page
itself. itself.
--->

View File

@ -1,16 +1,31 @@
### Description ### Description
Describe why you're making this change, in plain English.
<!--
Please describe why you're making this change, in plain English.
-->
### Testing & Reproduction steps ### Testing & Reproduction steps
<!--
* In the case of bugs, describe how to replicate * In the case of bugs, describe how to replicate
* If any manual tests were done, document the steps and the conditions to replicate * If any manual tests were done, document the steps and the conditions to replicate
* Call out any important/ relevant unit tests, e2e tests or integration tests you have added or are adding * Call out any important/ relevant unit tests, e2e tests or integration tests you have added or are adding
-->
### Links ### Links
<!--
Include any links here that might be helpful for people reviewing your PR (Tickets, GH issues, API docs, external benchmarks, tools docs, etc). If there are none, feel free to delete this section. Include any links here that might be helpful for people reviewing your PR (Tickets, GH issues, API docs, external benchmarks, tools docs, etc). If there are none, feel free to delete this section.
Please be mindful not to leak any customer or confidential information. HashiCorp employees may want to use our internal URL shortener to obfuscate links. Please be mindful not to leak any customer or confidential information. HashiCorp employees may want to use our internal URL shortener to obfuscate links.
-->
### PR Checklist ### PR Checklist
* [ ] updated test coverage * [ ] updated test coverage