From e884476f4c18d61da9f086b8b903f433d13c41f2 Mon Sep 17 00:00:00 2001 From: Hannah Oppenheimer Date: Tue, 8 May 2018 17:16:41 -0500 Subject: [PATCH 1/5] Issue template for UI issues --- .github/ISSUE_TEMPLATE/ui_issues.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/ui_issues.md diff --git a/.github/ISSUE_TEMPLATE/ui_issues.md b/.github/ISSUE_TEMPLATE/ui_issues.md new file mode 100644 index 0000000000..89b5cebd3f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/ui_issues.md @@ -0,0 +1,13 @@ +**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? From 081e6f446fd13fd0651f08997406bdd13f8c0dc2 Mon Sep 17 00:00:00 2001 From: Jack Pearkes Date: Thu, 10 May 2018 12:15:06 -0700 Subject: [PATCH 2/5] add frontmatter to UI issue template --- .github/ISSUE_TEMPLATE/ui_issues.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/ui_issues.md b/.github/ISSUE_TEMPLATE/ui_issues.md index 89b5cebd3f..edac9bf2d5 100644 --- a/.github/ISSUE_TEMPLATE/ui_issues.md +++ b/.github/ISSUE_TEMPLATE/ui_issues.md @@ -1,3 +1,9 @@ +--- +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. From 48c26a9d84f2ca02644c452d2f21d4ad9890edd6 Mon Sep 17 00:00:00 2001 From: Jack Pearkes Date: Thu, 10 May 2018 12:15:21 -0700 Subject: [PATCH 3/5] add feature request, bug report, and question issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 50 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 18 ++++++++ .github/ISSUE_TEMPLATE/question.md | 11 +++++ 3 files changed, 79 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/question.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000000..90001694ed --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -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 + +The `consul info` command provides information for us +about the agents running both as clients and servers. + +Client: + +``` +[Client `consul info` here] +``` + +Server: + +``` +[Server `consul info` here] +``` + +### 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/). + +Use `-log-level=TRACE` on the client and server to capture the maximum log detail. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000000..f789fafc94 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -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. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md new file mode 100644 index 0000000000..d85f76d9ae --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.md @@ -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) From 900a4ce813bf978fa39d42df4d0b86a04d9c3980 Mon Sep 17 00:00:00 2001 From: Jack Pearkes Date: Thu, 10 May 2018 12:15:39 -0700 Subject: [PATCH 4/5] remove old issue template --- ISSUE_TEMPLATE.md | 35 ----------------------------------- 1 file changed, 35 deletions(-) delete mode 100644 ISSUE_TEMPLATE.md diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md deleted file mode 100644 index 9729186aa2..0000000000 --- a/ISSUE_TEMPLATE.md +++ /dev/null @@ -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. From 891d7803db3707d687ab2f4268c71ab11a52a4c3 Mon Sep 17 00:00:00 2001 From: Jack Pearkes Date: Thu, 10 May 2018 12:55:26 -0700 Subject: [PATCH 5/5] change the bug report tempate to use the collapsable details view --- .github/ISSUE_TEMPLATE/bug_report.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 90001694ed..3e9359adcf 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -21,20 +21,19 @@ Steps to reproduce this issue, eg: ### Consul info for both Client and Server -The `consul info` command provides information for us -about the agents running both as clients and servers. - -Client: - +
+ Client info ``` -[Client `consul info` here] +output from client 'consul info' command here ``` +
-Server: - +
+ Client info ``` -[Server `consul info` here] +output from server 'consul info' command here ``` +
### Operating system and Environment details @@ -45,6 +44,7 @@ about the environment. 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/). +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.