From 87370a4fbca5d3fd2fa94d6752608d419c86cb67 Mon Sep 17 00:00:00 2001 From: Kim Schlesinger <10536053+kimschles@users.noreply.github.com> Date: Wed, 17 Jul 2019 14:34:07 -0600 Subject: [PATCH 1/4] Add issue templates I've added issues templates for bug reports, feature requests and other as a response to feedback left on this PR: https://github.com/FairwindsOps/polaris/pull/168. The goal of these templates is to better organize our issues, as well as encourage folks who are filing a bug report to check their version of polaris and update when necessary. --- .github/ISSUE_TEMPLATE/bug_report.md | 54 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 +++++++++ .github/ISSUE_TEMPLATE/other.md | 10 +++++ 3 files changed, 84 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/other.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 000000000..6cdb5b162 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,54 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: '' +assignees: '' + +--- + +--- +name: Bug report +about: Let us know about an unexpected error, a crash, or an incorrect behavior. + +--- + +### Polaris Version + + +``` +... +``` + +### Expected Behavior + + +### Actual Behavior + + +### Steps to Reproduce + + +### Additional Context + + +### References + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 000000000..bbcbbe7d6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: '' +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/other.md b/.github/ISSUE_TEMPLATE/other.md new file mode 100644 index 000000000..5a3bcaf36 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/other.md @@ -0,0 +1,10 @@ +--- +name: Other +about: For misc. tasks like research or continued conversation +title: '' +labels: '' +assignees: kimschles + +--- + + From 20bf86ec1279c0a1717fc16a8a59ebf6f202bdaf Mon Sep 17 00:00:00 2001 From: Kim Schlesinger <10536053+kimschles@users.noreply.github.com> Date: Wed, 17 Jul 2019 14:47:31 -0600 Subject: [PATCH 2/4] Update bug_report.md --- .github/ISSUE_TEMPLATE/bug_report.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 6cdb5b162..b143a1007 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -12,10 +12,14 @@ name: Bug report about: Let us know about an unexpected error, a crash, or an incorrect behavior. --- +### Installation Process + ### Polaris Version From 821de5fa8fd0bd5b455023aa57f4a779b2e2c271 Mon Sep 17 00:00:00 2001 From: Kim Schlesinger <10536053+kimschles@users.noreply.github.com> Date: Fri, 19 Jul 2019 14:08:09 -0600 Subject: [PATCH 3/4] Update other.md --- .github/ISSUE_TEMPLATE/other.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/other.md b/.github/ISSUE_TEMPLATE/other.md index 5a3bcaf36..58e0dc6a1 100644 --- a/.github/ISSUE_TEMPLATE/other.md +++ b/.github/ISSUE_TEMPLATE/other.md @@ -3,7 +3,7 @@ name: Other about: For misc. tasks like research or continued conversation title: '' labels: '' -assignees: kimschles +assignees: '' --- From 5e67812d5a5cd373efec43af9400b26526c2a2dd Mon Sep 17 00:00:00 2001 From: Kim Schlesinger <10536053+kimschles@users.noreply.github.com> Date: Fri, 19 Jul 2019 14:13:17 -0600 Subject: [PATCH 4/4] Update CONTRIBUTING.md --- CONTRIBUTING.md | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d0ef4c187..7bac8abba 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -40,11 +40,8 @@ go test ./pkg/... -v -coverprofile cover.out ## Creating a New Issue -If you've encountered an issue that is not already reported, please create an issue that contains the following: +If you've encountered an issue that is not already reported, please create a [new issue](https://github.com/FairwindsOps/polaris/issues), choose `Bug Report`, `Feature Request` or `Misc.` and follow the instructions in the template. -- Clear description of the issue -- Steps to reproduce it -- Appropriate labels ## Creating a Pull Request