From b9d7ce9c78a0a0685ba20586be7c7384bb8650fa Mon Sep 17 00:00:00 2001 From: David Eliahu Date: Tue, 26 Mar 2019 11:25:15 -0700 Subject: [PATCH 1/2] Add issue templates --- .github/ISSUE_TEMPLATE/bug-report.md | 55 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature-request.md | 34 ++++++++++++++ .github/ISSUE_TEMPLATE/question.md | 10 +++++ 3 files changed, 99 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..691c7b6725 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -0,0 +1,55 @@ +--- +name: Bug Report +about: Report a bug +title: '' +labels: bug +assignees: '' + +--- + + + +### Description + +[Description of the bug] + +### Application Configuration + +[If applicable, any relevant resource YAML configuration or the name of the example application] + +### To Reproduce + +[Minimal set of steps to reproduce the behavior] + +1. ... +1. ... +1. ... + +### Actual Behavior + +[Description of the actual behavior] + +### Expected Behavior + +[Description of the expected behavior] + +### Screenshots + +[If applicable, any screenshots that show the issue] + +### Stack Trace + +[If applicable, the stack trace which shows the error. Find it with `cortex logs `, or use `kubectl get pods -n cortex` and use the name of the failed pod in `kubectl logs -n cortex`] + +``` + +``` + +### Version +[e.g. `0.2.2` or `master` (find with `cortex --version`)] + +### Additional Context +[If applicable, any other context about the problem] + +### Possible Solution / Implementation +[Optional] diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md new file mode 100644 index 0000000000..e2047bb14e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -0,0 +1,34 @@ +--- +name: Feature Request +about: Suggest a feature +title: '' +labels: enhancement +assignees: '' + +--- + + + +### Summary + +[A brief summary of the feature] + +### Motivation + +[An explanation of how this will improve the product, what problem this will solve, what the use case is, and/or which users will benefit most] + +### Design + +[Optional: Detailed description of how it will behave, API changes (CLI or configuration), design, etc. Include all designs considered and their pros/cons] + +### Drawbacks + +[Optional: Any downsides of adding this feature] + +### Alternatives + +[Optional: Any alternative solutions or features that would solve the same problem] + +### Additional Context + +[Optional: Any relevant context, notes, or resources] diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md new file mode 100644 index 0000000000..d149357b46 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.md @@ -0,0 +1,10 @@ +--- +name: Question +about: Ask a question +title: '' +labels: question +assignees: '' + +--- + + From b1405b3c41db9579655d3890585e060f801e93b8 Mon Sep 17 00:00:00 2001 From: David Eliahu Date: Tue, 26 Mar 2019 20:16:40 -0700 Subject: [PATCH 2/2] Address comments --- .github/ISSUE_TEMPLATE/bug-report.md | 7 +++++-- .github/ISSUE_TEMPLATE/feature-request.md | 22 ++++------------------ .github/ISSUE_TEMPLATE/question.md | 2 -- 3 files changed, 9 insertions(+), 22 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md index 691c7b6725..a1ccdba7f3 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -22,8 +22,8 @@ assignees: '' [Minimal set of steps to reproduce the behavior] 1. ... -1. ... -1. ... +2. ... +3. ... ### Actual Behavior @@ -46,10 +46,13 @@ assignees: '' ``` ### Version + [e.g. `0.2.2` or `master` (find with `cortex --version`)] ### Additional Context + [If applicable, any other context about the problem] ### Possible Solution / Implementation + [Optional] diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md index e2047bb14e..9d2ece74dc 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.md +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -7,28 +7,14 @@ assignees: '' --- - +### Description -### Summary - -[A brief summary of the feature] +[A description of the feature] ### Motivation -[An explanation of how this will improve the product, what problem this will solve, what the use case is, and/or which users will benefit most] - -### Design - -[Optional: Detailed description of how it will behave, API changes (CLI or configuration), design, etc. Include all designs considered and their pros/cons] - -### Drawbacks - -[Optional: Any downsides of adding this feature] - -### Alternatives - -[Optional: Any alternative solutions or features that would solve the same problem] +[An explanation of how this will improve the product, what problem this will solve, and/or what the use case is] ### Additional Context -[Optional: Any relevant context, notes, or resources] +[Optional: Any relevant context, designs, notes, or resources] diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md index d149357b46..cc2ea122ce 100644 --- a/.github/ISSUE_TEMPLATE/question.md +++ b/.github/ISSUE_TEMPLATE/question.md @@ -6,5 +6,3 @@ labels: question assignees: '' --- - -