From 89822a446161f1ccb3b84d53f8528bc8b0a28053 Mon Sep 17 00:00:00 2001 From: Adin Scannell Date: Tue, 21 Apr 2020 13:12:38 -0700 Subject: Move to GitHub's new issue templates. This allows us to specify a richer configuration for the issue template, that effectively moves a lot of the "metadata" from the template itself to the main issue page. PiperOrigin-RevId: 307666509 --- .github/ISSUE_TEMPLATE/bug_report.md | 31 +++++++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 14 ++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 21 +++++++++++++++++++++ .github/issue_template.md | 20 -------------------- 4 files changed, 66 insertions(+), 20 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md delete mode 100644 .github/issue_template.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 000000000..49a1ba697 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,31 @@ +--- +name: Bug report +about: Create a bug report to help us improve +title: +labels: + - 'type: bug' +assignees: '' +--- + +**Description** + +A clear description of what the bug is. If possible, explicitly indicate the +expected behavior vs. the observed behavior. + +**Steps to reproduce** + +If available, please include detailed reproduction steps. + +If the bug requires software that is not publicly available, see if it can be +reproduced with software that is publicly available. + +**Environment** + +Please include the following details of your environment: + +* `runsc -v` +* `docker version` or `docker info` (if available) +* `kubectl version` and `kubectl get nodes` (if using Kubernetes) +* `uname -a` +* `git describe` (if built from source) +* `runsc` debug logs (if available) diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..f42510b1f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,14 @@ +blank_issues_enabled: false +contact_links: + - name: gVisor Documentation (FAQ) + url: https://gvisor.dev/docs/user_guide/faq/ + about: Please see our documentation for common questions and answers. + - name: gVisor Documentation (Debugging) + url: https://gvisor.dev/docs/user_guide/debugging/ + about: Please see our documentation for debugging tips. + - name: gVisor User Forum + url: https://groups.google.com/g/gvisor-users + about: Please ask and answer questions here. + - name: gVisor Security List + url: https://github.com/google/gvisor/blob/master/SECURITY.md + about: Please report security vulnerabilities using the process described here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 000000000..65f60f385 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,21 @@ +--- +name: Feature request +about: Suggest an idea or improvement +title: '' +labels: + - 'type: enhancement' +assignees: '' +--- + +**Description** + +A clear description of the feature or enhancement. + +**Is this feature related to a specific bug?** + +Please include a bug references if yes. + +**Do you have a specific solution in mind?** + +Please include any details about a solution that you have in mind, including any +alternatives considered. diff --git a/.github/issue_template.md b/.github/issue_template.md deleted file mode 100644 index 77c401d22..000000000 --- a/.github/issue_template.md +++ /dev/null @@ -1,20 +0,0 @@ -Before filling an issue, please consult our FAQ: -https://gvisor.dev/docs/user_guide/faq/ - -Also check that the issue hasn't been reported before. - -If you have a question, please email gvisor-users@googlegroups.com rather than filing a bug. - -If you believe you've found a security issue, please email gvisor-security@googlegroups.com rather than filing a bug. - -If this is your first time compiling or running gVisor, please make sure that your system meets the minimum requirements: https://github.com/google/gvisor#requirements - -For all other issues, please attach debug logs. To get debug logs, follow the -instructions here: https://gvisor.dev/docs/user_guide/debugging/ - -Other useful information to include is: - -* `runsc -v` -* `docker version` or `docker info` if more relevant -* `uname -a` - `git describe` -* Detailed reproduction steps -- cgit v1.2.3