Merge pull request #4096 from hashicorp/issue-templates

WIP Issue template for UI issues
This commit is contained in:
Jack Pearkes 2018-05-10 17:19:05 -07:00 committed by GitHub
commit 171adf79a5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 98 additions and 35 deletions

50
.github/ISSUE_TEMPLATE/bug_report.md vendored Normal file
View File

@ -0,0 +1,50 @@
---
name: Bug Report
about: You're experiencing an issue with Consul that is different than the documented behavior.
---
When filing a bug, please include the following headings if
possible. Any example text in this template can be deleted.
#### Overview of the Issue
A paragraph or two about the issue you're experiencing.
#### Reproduction Steps
Steps to reproduce this issue, eg:
1. Create a cluster with n client nodes n and n server nodes
1. Run `curl ...`
1. View error
### Consul info for both Client and Server
<details>
<summary>Client info</summary>
```
output from client 'consul info' command here
```
<details>
<details>
<summary>Client info</summary>
```
output from server 'consul info' command here
```
<details>
### Operating system and Environment details
OS, Architecture, and any other information you can provide
about the environment.
### Log Fragments
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

@ -0,0 +1,18 @@
---
name: Feature Request
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 to add upvotes to pre-existing
requests.
#### Feature Description
A written overview of the feature.
#### Use Case(s)
Any relevant use-cases that you see.

11
.github/ISSUE_TEMPLATE/question.md vendored Normal file
View File

@ -0,0 +1,11 @@
---
name: Question
about: If you have a question, please check out our other community resources instead of opening an issue.
---
Issues on GitHub are intended to be related to bugs or feature requests, so we recommend using our other community resources instead of asking here.
- [FAQ (Frequently asked questions)](https://www.consul.io/docs/faq.html)
- [Consul Guides](https://www.consul.io/docs/guides/index.html)
- Any other questions can be sent to the [consul mailing list](https://www.consul.io/community.html)

19
.github/ISSUE_TEMPLATE/ui_issues.md vendored Normal file
View File

@ -0,0 +1,19 @@
---
name: Web UI Feedback
about: You have usage feedback for either version of the web UI
---
**Old UI or New UI**
If you're using Consul 1.1.0 or later, you can use the new UI with the change of
an environment variable. Let us know which UI you're using so that we can help.
**Describe the problem you're having**
A clear and concise description of what could be better. If you have screenshots
of a bug, place them here.
**Describe the solution you'd like**
A clear and concise description of what you want to happen.
**Share inspiration**
How have you seen this problem solved well in other UIs?

View File

@ -1,35 +0,0 @@
If you have a question, please direct it to the
[consul mailing list](https://www.consul.io/community.html) if it hasn't been
addressed in either the [FAQ](https://www.consul.io/docs/faq.html) or in one
of the [Consul Guides](https://www.consul.io/docs/guides/index.html).
When filing a bug, please include the following:
### Description of the Issue (and unexpected/desired result)
### Reproduction steps
### `consul version` for both Client and Server
Client: `[client version here]`
Server: `[server version here]`
### `consul info` for both Client and Server
Client:
```
[Client `consul info` here]
```
Server:
```
[Server `consul info` here]
```
### Operating system and Environment details
### Log Fragments or Link to [gist](https://gist.github.com/)
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/).
TIP: Use `-log-level=TRACE` on the client and server to capture the maximum log detail.