From bda26aa42be3f82851b70fa452dd62930ad58338 Mon Sep 17 00:00:00 2001 From: Greg Curtis Date: Tue, 30 Jan 2024 14:56:24 -0500 Subject: [PATCH] github: add issue template forms Convert our existing issue templates to [forms][1] to make it easier to get helpful bug/feature info. Issues created from a template will have a `triage` label applied by default, indicating that it needs to be looked at by someone from the team. After an issue has been triaged/validated, this label should be removed. Hopefully this will make it easier to track issues that are ready to be worked on. [1]: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#creating-issue-forms --- .github/ISSUE_TEMPLATE/01-bug.yaml | 86 +++++++++++++++++++ .github/ISSUE_TEMPLATE/02-feature.yaml | 32 +++++++ .github/ISSUE_TEMPLATE/03-package-bug.yaml | 28 ++++++ .../ISSUE_TEMPLATE/04-package-request.yaml | 31 +++++++ .github/ISSUE_TEMPLATE/bugs.md | 17 ---- .github/ISSUE_TEMPLATE/feature-request.md | 19 ---- .github/ISSUE_TEMPLATE/package-issue.md | 18 ---- .github/ISSUE_TEMPLATE/plugin-request.md | 20 ----- 8 files changed, 177 insertions(+), 74 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/01-bug.yaml create mode 100644 .github/ISSUE_TEMPLATE/02-feature.yaml create mode 100644 .github/ISSUE_TEMPLATE/03-package-bug.yaml create mode 100644 .github/ISSUE_TEMPLATE/04-package-request.yaml delete mode 100644 .github/ISSUE_TEMPLATE/bugs.md delete mode 100644 .github/ISSUE_TEMPLATE/feature-request.md delete mode 100644 .github/ISSUE_TEMPLATE/package-issue.md delete mode 100644 .github/ISSUE_TEMPLATE/plugin-request.md diff --git a/.github/ISSUE_TEMPLATE/01-bug.yaml b/.github/ISSUE_TEMPLATE/01-bug.yaml new file mode 100644 index 00000000000..f0f5691b35e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/01-bug.yaml @@ -0,0 +1,86 @@ +name: Bug Report +description: File a bug report +labels: + - bug + - triage +body: + - type: textarea + id: description + attributes: + label: What happened? + description: >- + Also include what you expected to happen and any other relevant details. + validations: + required: true + - type: textarea + id: repro + attributes: + label: Steps to reproduce + description: >- + What specific steps can we take to reproduce this issue? + Including a script would be much appreciated! + value: | + 1. + 2. + 3. + - type: dropdown + id: commands + attributes: + label: Command + description: What Devbox command were you running when the bug occurred? + multiple: true + options: + - add + - auth + - create + - generate + - global + - info + - init + - install + - rm + - run + - search + - services + - shell + - shellenv + - update + - version + - type: textarea + id: devbox-json + attributes: + label: devbox.json + description: Please include a copy of your devbox.json file. + render: "jsonc" + - type: input + id: devbox-version + attributes: + label: Devbox version + description: "Paste the output of `devbox version`." + validations: + required: true + - type: input + id: nix-version + attributes: + label: Nix version + description: "Paste the output of `nix --version`." + - type: dropdown + id: system + attributes: + label: What system does this bug occur on? + options: + - macOS (Intel) + - macOS (Apple Silicon) + - Linux (x86-64) + - Linux (ARM64) + - Other (please include in the description above) + validations: + required: true + - type: textarea + id: logs + attributes: + label: Debug logs + description: >- + If possible, reproduce the bug with the `DEVBOX_DEBUG=1` environment + variable set and paste any output here. + For example: `DEVBOX_DEBUG=1 devbox run -- mycrash.sh`. diff --git a/.github/ISSUE_TEMPLATE/02-feature.yaml b/.github/ISSUE_TEMPLATE/02-feature.yaml new file mode 100644 index 00000000000..1feb875ba8b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/02-feature.yaml @@ -0,0 +1,32 @@ +name: Feature Request +description: Suggest an idea or new feature +labels: + - feature + - triage +body: + - type: textarea + id: problem + attributes: + label: What problem are you trying to solve? + description: >- + Describe the problem you're trying to solve with this feature. + placeholder: I'm always frustrated when... + validations: + required: true + - type: textarea + id: solution + attributes: + label: What solution would you like? + description: >- + Describe the feature you would like to see implemented and explain how + it would address the problem you described above. + validations: + required: true + - type: textarea + id: alternatives + attributes: + label: Alternatives you've considered + description: >- + Describe any alternative solutions or features you've considered. If you + know of any similar features requested before, please include links to + them. diff --git a/.github/ISSUE_TEMPLATE/03-package-bug.yaml b/.github/ISSUE_TEMPLATE/03-package-bug.yaml new file mode 100644 index 00000000000..fff385b3266 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/03-package-bug.yaml @@ -0,0 +1,28 @@ +name: Package Issue +description: Report a problem with an existing package on either Devbox or Nixhub +labels: + - package + - bug + - triage +body: + - type: input + id: name + attributes: + label: Package name + placeholder: go@1.21.6, python@3.10.13, etc. + validations: + required: true + - type: textarea + id: solution + attributes: + label: What changes are you requesting? + description: >- + Describe what's going wrong or what changes you'd like to see to the + package. + validations: + required: true + - type: input + id: link + attributes: + label: Nixhub link + placeholder: https://www.nixhub.io/packages/go diff --git a/.github/ISSUE_TEMPLATE/04-package-request.yaml b/.github/ISSUE_TEMPLATE/04-package-request.yaml new file mode 100644 index 00000000000..e1ac62669b8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/04-package-request.yaml @@ -0,0 +1,31 @@ +name: Package Request +description: Request a new package to be added to Devbox and Nixhub +labels: + - package + - triage +body: + - type: input + id: name + attributes: + label: Package name + description: What name are you requesting for the new package? + validations: + required: true + - type: input + id: nixpkgs + attributes: + label: Nix package link + description: >- + Are you able to find the package on https://search.nixos.org/packages? + If so, please include a link to the search results. Otherwise, leave + blank. + - type: textarea + id: software + attributes: + label: Software + description: >- + Provide a description of the software that should be added to the new + package. Include any relevant links such as websites, + GitHub repositories, etc. + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/bugs.md b/.github/ISSUE_TEMPLATE/bugs.md deleted file mode 100644 index 09fba76166c..00000000000 --- a/.github/ISSUE_TEMPLATE/bugs.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -name: Bug Report -about: Report something that is not working as expected -title: "[Bug]: " -labels: bug - ---- - -**Current Behavior (bug)** -A clear and concise description of what the bug is. - -**Expected Behavior (fix)** -A clear and concise description of what you expected to happen. - -**Additional context** -Please include the output of `devbox version -v` and -a copy of your `devbox.json` file. diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md deleted file mode 100644 index 0f34a9e3e6f..00000000000 --- a/.github/ISSUE_TEMPLATE/feature-request.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -name: Feature request -about: Suggest an idea or new feature for this project -title: '[Feature]: ' -labels: feature - ---- - -**Is your feature request related to a problem you're trying to solve? 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. Has the feature been requested before? If so, provide a link to the issue. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/package-issue.md b/.github/ISSUE_TEMPLATE/package-issue.md deleted file mode 100644 index 4b6ccff28d8..00000000000 --- a/.github/ISSUE_TEMPLATE/package-issue.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -name: Package Issue Report -about: Request a new package or report a problem with an existing package on either Devbox or Nixhub -title: "[Package Issue Report]: " -labels: package issue -assignees: Lagoja ---- -**Are you requesting a new package or reporting an issue on an existing one?** - -**If reporting an issue on an existing one, what is the name of the package?** -Please use the name as it appears in https://www.nixhub.io - -**What changes are you requesting?** -Summarize your request. If it's for an existing package that is not -working as expectd, provide a concise explanation of what is going wrong. - -**Additional context** -Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/plugin-request.md b/.github/ISSUE_TEMPLATE/plugin-request.md deleted file mode 100644 index 977e18c9fd7..00000000000 --- a/.github/ISSUE_TEMPLATE/plugin-request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Plugin Request -about: Suggest a new Plugin -title: "[Plugin Request]: " -labels: plugin request -assignees: Lagoja - ---- - -** What is the name of the package(s) you are requesting a plugin for?** -Please use the name as it appears in https://search.nixos.org/packages. - -**Does the package work today?** -If not, provide a concise explanation of what is going wrong - -**[Optional] What configuration would you propose for this plugin?** -E.g., create a service, environment variables, helper files, etc. - -**Additional context** -Add any other context or screenshots about the feature request here.