diff options
| author | William Boman <william@redwill.se> | 2022-10-18 14:04:52 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-10-18 12:04:52 +0000 |
| commit | 0a279a9cdf6424f33a35ea3819496b844c9bf7fc (patch) | |
| tree | dfe2a6c8639b93153f828673c5a53ca1cf723bd1 /.github | |
| parent | chore: update generated code (#571) (diff) | |
| download | mason-0a279a9cdf6424f33a35ea3819496b844c9bf7fc.tar mason-0a279a9cdf6424f33a35ea3819496b844c9bf7fc.tar.gz mason-0a279a9cdf6424f33a35ea3819496b844c9bf7fc.tar.bz2 mason-0a279a9cdf6424f33a35ea3819496b844c9bf7fc.tar.lz mason-0a279a9cdf6424f33a35ea3819496b844c9bf7fc.tar.xz mason-0a279a9cdf6424f33a35ea3819496b844c9bf7fc.tar.zst mason-0a279a9cdf6424f33a35ea3819496b844c9bf7fc.zip | |
chore: update issue templates (#572)
Diffstat (limited to '.github')
| -rw-r--r-- | .github/ISSUE_TEMPLATE/config.yml | 2 | ||||
| -rw-r--r-- | .github/ISSUE_TEMPLATE/feature_request.yaml | 8 | ||||
| -rw-r--r-- | .github/ISSUE_TEMPLATE/general_issue.yaml | 62 | ||||
| -rw-r--r-- | .github/ISSUE_TEMPLATE/new_package_request.yaml | 13 | ||||
| -rw-r--r-- | .github/ISSUE_TEMPLATE/package_installation_form.yaml | 72 | ||||
| -rw-r--r-- | .github/ISSUE_TEMPLATE/package_issue.yaml | 85 |
6 files changed, 129 insertions, 113 deletions
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 70db94b2..df7a6397 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,3 +1,5 @@ +--- + contact_links: - name: Ask a question about mason.nvim or get support url: https://github.com/williamboman/mason.nvim/discussions/new?category=q-a diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml index d0457909..0814d183 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yaml +++ b/.github/ISSUE_TEMPLATE/feature_request.yaml @@ -1,15 +1,17 @@ +--- + name: Feature request description: Suggest an idea for this project labels: - enhancement body: - - type: checkboxes + - type: dropdown attributes: label: I've searched open issues for similar requests - description: If possible, please contribute to any open issues instead of opening a new one. + description: If possible, please contribute to any [open issues](https://github.com/williamboman/mason.nvim/issues) instead of opening a new one. options: - - label: "Yes" + - "Yes" validations: required: true diff --git a/.github/ISSUE_TEMPLATE/general_issue.yaml b/.github/ISSUE_TEMPLATE/general_issue.yaml index ec6d9d75..38b349ba 100644 --- a/.github/ISSUE_TEMPLATE/general_issue.yaml +++ b/.github/ISSUE_TEMPLATE/general_issue.yaml @@ -1,3 +1,4 @@ +--- name: Non-package-related issue description: Report an issue not related to installation or usage of packages @@ -5,31 +6,19 @@ body: - type: markdown attributes: value: | - 1. 👋! This is not an issue template for questions! If you have questions, please refer to [the discussion board](https://github.com/williamboman/mason.nvim/discussions/categories/q-a) :) - 1. Before reporting an issue, make sure that you meet the minimum requirements mentioned in the README. + # Issue reporting guidelines - - type: textarea - attributes: - label: Problem description - description: A clear and concise description of what the issue is and why you think it's an issue with mason.nvim. - validations: - required: true + 1. This is not a general support board for package usage questions (e.g. "How do I do X?"). For questions, please refer to [the discussion board](https://github.com/williamboman/mason.nvim/discussions/categories/q-a) first! :) + 1. Before reporting an issue, make sure that you meet the minimum requirements mentioned in the README. Also review `:checkhealth mason` for potential problems. - - type: textarea - attributes: - label: "Neovim version (>= 0.7)" - description: "Output of `nvim --version`" - placeholder: | - NVIM v0.7.0-dev - Build type: Release - LuaJIT 2.1.0-beta3 - validations: - required: true + --- - - type: input + - type: dropdown attributes: - label: "Operating system/version" - description: "On Linux and Mac systems: `$ uname -a`" + label: I've searched open issues for similar requests + description: If possible, please contribute to any [open issues](https://github.com/williamboman/mason.nvim/issues?q=is%3Aissue) instead of opening a new one. + options: + - "Yes" validations: required: true @@ -41,8 +30,8 @@ body: - type: textarea attributes: - label: Actual behavior - description: A short description of what's happening. + label: Problem description + description: A clear and short description of 1) what the issue is, and 2) why you think it's an issue with mason.nvim. validations: required: true @@ -55,6 +44,33 @@ body: - type: textarea attributes: + label: Steps to reproduce + placeholder: | + 1. ... + 2. ... + validations: + required: true + + - type: textarea + attributes: + label: "Neovim version (>= 0.7)" + description: "Output of `nvim --version`" + placeholder: | + NVIM v0.7.0-dev + Build type: Release + LuaJIT 2.1.0-beta3 + validations: + required: true + + - type: input + attributes: + label: "Operating system/version" + description: "On Linux and Mac systems: `$ uname -a`" + validations: + required: true + + - type: textarea + attributes: label: Healthcheck output placeholder: ":checkhealth mason" render: shell diff --git a/.github/ISSUE_TEMPLATE/new_package_request.yaml b/.github/ISSUE_TEMPLATE/new_package_request.yaml index 0e131943..a982e260 100644 --- a/.github/ISSUE_TEMPLATE/new_package_request.yaml +++ b/.github/ISSUE_TEMPLATE/new_package_request.yaml @@ -1,3 +1,5 @@ +--- + name: New package request description: Request a new package not currently available title: "[New package]: " @@ -5,6 +7,15 @@ labels: - new-package-request body: + - type: dropdown + attributes: + label: I've searched open & closed issues for similar requests + description: If possible, please contribute to [existing issues](https://github.com/williamboman/mason.nvim/issues?q=is%3Aissue+label%3Anew-package-request) instead of opening a new one. + options: + - "Yes" + validations: + required: true + - type: input attributes: label: Package name @@ -24,8 +35,6 @@ body: label: Languages description: Which languages does this package target? placeholder: typescript, javascript - validations: - required: true - type: textarea attributes: diff --git a/.github/ISSUE_TEMPLATE/package_installation_form.yaml b/.github/ISSUE_TEMPLATE/package_installation_form.yaml index 3bdd2d64..5f18e5f0 100644 --- a/.github/ISSUE_TEMPLATE/package_installation_form.yaml +++ b/.github/ISSUE_TEMPLATE/package_installation_form.yaml @@ -1,3 +1,5 @@ +--- + name: Package installation issue description: Report an issue that occurs during the installation of a package labels: @@ -7,16 +9,19 @@ body: - type: markdown attributes: value: | - 1. 👋! This is not an issue template for questions! If you have questions, please refer to [the discussion board](https://github.com/williamboman/mason.nvim/discussions/categories/q-a) :) - 1. Before reporting an issue, make sure that you meet the minimum requirements mentioned in the README. - 1. This is not a general support board for package installation issues. Please review the error output yourself first and ensure it's not a problem that is local to your system only. + # Issue reporting guidelines - - type: checkboxes + 1. Before reporting an issue, make sure that you meet the minimum requirements mentioned in the README. Also review `:checkhealth mason` for potential problems. + 1. Please try to review the error yourself first and ensure it's not a problem that is local to your system only. + + --- + + - type: dropdown attributes: - label: I've made an initial investigation into the error myself - description: I've made an investigation and believe this is an error with mason.nvim (or that an improvement could be made). + label: I've searched open issues for similar requests + description: If possible, please contribute to any [open issues](https://github.com/williamboman/mason.nvim/issues?q=is%3Aissue+label%3Ainstallation-issue) instead of opening a new one. options: - - label: "Yes" + - "Yes" validations: required: true @@ -25,31 +30,18 @@ body: label: I've recently downloaded the latest plugin version of mason.nvim options: - label: "Yes" - validations: - required: true - type: textarea attributes: label: Problem description - description: A clear and concise description of what the issue is and why you think it's an issue with mason.nvim. + description: A clear and short description of 1) what the issue is, and 2) why you think it's an issue with mason.nvim. validations: required: true - type: textarea attributes: - label: "Neovim version (>= 0.7)" - description: "Output of `nvim --version`" - placeholder: | - NVIM v0.7.0-dev - Build type: Release - LuaJIT 2.1.0-beta3 - validations: - required: true - - - type: input - attributes: - label: "Operating system/version" - description: "On Linux and Mac systems: `$ uname -a`" + label: Expected behavior + description: A short description of the behavior you expected. validations: required: true @@ -62,31 +54,35 @@ body: - type: textarea attributes: - label: Actual behavior - description: A short description of what's happening. - validations: - required: true + label: Mason output + description: Please provide the **installation output** available in the `:Mason` window, if possible. + placeholder: "Please only provide the output of the package installation." + render: Text - type: textarea attributes: - label: Expected behavior - description: A short description of the behavior you expected. + label: Installation log + description: "`:MasonLog`. Refer to `:help mason-debugging`" + placeholder: "The default log level is not helpful for debugging purposes! Make sure you set the log level to DEBUG before installing the package (:h mason-debugging)." + render: Text validations: required: true - type: textarea attributes: - label: Mason output - description: Please provide the installation output available in the `:Mason` window, if possible. - placeholder: ":Mason" - render: Text + label: "Neovim version (>= 0.7)" + description: "Output of `nvim --version`" + placeholder: | + NVIM v0.7.0-dev + Build type: Release + LuaJIT 2.1.0-beta3 + validations: + required: true - - type: textarea + - type: input attributes: - label: Installation log - description: "Make sure you set the log level to DEBUG before installing the package. Refer to `:help mason-debugging`" - placeholder: ":MasonLog. Make sure you set the log level to DEBUG before installing the package (:h mason-debugging). The default log level is not helpful for debugging purposes." - render: Text + label: "Operating system/version" + description: "On Linux and Mac systems: `$ uname -a`" validations: required: true diff --git a/.github/ISSUE_TEMPLATE/package_issue.yaml b/.github/ISSUE_TEMPLATE/package_issue.yaml index 9f4bbe7f..2f57dc35 100644 --- a/.github/ISSUE_TEMPLATE/package_issue.yaml +++ b/.github/ISSUE_TEMPLATE/package_issue.yaml @@ -1,3 +1,5 @@ +--- + name: Package issue description: Report an issue with using a package installed via mason.nvim labels: @@ -7,50 +9,30 @@ body: - type: markdown attributes: value: | - 1. 👋! This is not an issue template for questions! If you have questions, please refer to [the discussion board](https://github.com/williamboman/mason.nvim/discussions/categories/q-a) :) - 1. Before reporting an issue, make sure that you meet the minimum requirements mentioned in the README. - 1. General usage issues with packages should not be reported here. Please only report issues that you believe are a result of something that mason.nvim does. + # Issue reporting guidelines - - type: checkboxes - attributes: - label: I believe this to be an issue that should be addressed by maintainers of mason.nvim. - description: I don't believe this is an issue with (i) the package itself, or (ii) my local system. - options: - - label: "Yes" - validations: - required: true - - - type: textarea - attributes: - label: Why do you think this is an issue with mason.nvim? - description: A short explanation of why you think it's an issue with mason.nvim. - validations: - required: true + 1. This is not a general support board for package usage questions (e.g. "How do I do X?"). For questions, please refer to [the discussion board](https://github.com/williamboman/mason.nvim/discussions/categories/q-a) first! :) + 1. Before reporting an issue, make sure that you meet the minimum requirements mentioned in the README. Also review `:checkhealth mason` for potential problems. + 1. General usage issues with packages should not be reported here. Please only report issues that you believe are a result of something that mason.nvim does. + 1. Please try to review errors yourself first and ensure it's not a problem that is local to your system only. - - type: textarea - attributes: - label: "Neovim version (>= 0.7)" - description: "Output of `nvim --version`" - placeholder: | - NVIM v0.7.0-dev - Build type: Release - LuaJIT 2.1.0-beta3 - validations: - required: true + --- - - type: input + - type: dropdown attributes: - label: "Operating system/version" - description: "On Linux and Mac systems: `$ uname -a`" + label: I've searched open issues for similar requests + description: If possible, please contribute to any open issues instead of opening a new one. + options: + - "Yes" validations: required: true - - type: checkboxes + - type: dropdown attributes: label: I've manually reviewed logs to find potential errors - description: Logs such as `:MasonLog`, `:LspLog`, etc. + description: Logs such as `:MasonLog`, `:LspLog`, etc. (don't paste logs without reviewing them yourself first) options: - - label: "Yes" + - "Yes" validations: required: true @@ -59,20 +41,18 @@ body: label: I've recently downloaded the latest plugin version of mason.nvim options: - label: "Yes" - validations: - required: true - - type: input + - type: textarea attributes: - label: Affected packages - description: If this issue is specific to one or more packages, list them here. If not, write 'All'. + label: Problem description + description: A clear and short description of 1) what the issue is, and 2) why you think it's an issue with mason.nvim. validations: required: true - type: textarea attributes: - label: Problem description - description: A clear and concise description of what the issue is. + label: Expected behavior + description: A description of the behavior you expected. validations: required: true @@ -85,17 +65,28 @@ body: validations: required: true - - type: textarea + - type: input attributes: - label: Actual behavior - description: Observed behavior. + label: Affected packages + description: If this issue is specific to one or more packages, list them here. If not, write 'All'. validations: required: true - type: textarea attributes: - label: Expected behavior - description: A description of the behavior you expected. + label: "Neovim version (>= 0.7)" + description: "Output of `nvim --version`" + placeholder: | + NVIM v0.7.0-dev + Build type: Release + LuaJIT 2.1.0-beta3 + validations: + required: true + + - type: input + attributes: + label: "Operating system/version" + description: "On Linux and Mac systems: `$ uname -a`" validations: required: true @@ -111,4 +102,4 @@ body: id: screenshots attributes: label: Screenshots or recordings - description: If applicable, add screenshots or recordings to help explain your problem + description: If applicable, add screenshots or recordings to help explain your problem. |
