diff --git a/.github/DISCUSSION_TEMPLATE/help.yml b/.github/DISCUSSION_TEMPLATE/help.yml new file mode 100644 index 0000000..b1b28f3 --- /dev/null +++ b/.github/DISCUSSION_TEMPLATE/help.yml @@ -0,0 +1,19 @@ +title: "[Help] " +body: + - type: checkboxes + id: checks + attributes: + label: Verify + options: + - label: I searched the existing discussions for help + required: true + - type: textarea + id: help + attributes: + label: How can we help you? + validations: + required: true + - type: markdown + attributes: + value: | + :warning: Unfortunately, my time is limited and I can't offer reliable user support. I might answer if you catch me on a slow day, or hopefully someone else will. diff --git a/.github/DISCUSSION_TEMPLATE/ideas.yml b/.github/DISCUSSION_TEMPLATE/ideas.yml new file mode 100644 index 0000000..7e0020b --- /dev/null +++ b/.github/DISCUSSION_TEMPLATE/ideas.yml @@ -0,0 +1,14 @@ +body: + - type: checkboxes + id: checks + attributes: + label: Verify + options: + - label: I searched the existing discussions for similar ideas + required: true + - type: textarea + id: help + attributes: + label: Share your idea or feature request + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..2804631 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,82 @@ +name: Bug report +description: File a bug report to help improve zk-nvim. +body: + - type: markdown + attributes: + value: | + Thank you for filing a bug report! + - type: checkboxes + id: checks + attributes: + label: Check if applicable + description: | + :warning: At the moment, there are no official lua maintainer for this project. Your bug report might be ignored, no hard feelings. + :heart: But if you would like to contribute a fix yourself, **I'll be happy to review a pull request**. + options: + - label: I have searched the existing issues (**required**) + required: true + - label: I'm willing to help fix the problem and contribute a pull request + - type: textarea + id: bug-description + attributes: + label: Describe the bug + description: Also tell me, what did you expect to happen? + placeholder: A clear and concise description of what the bug is. + validations: + required: true + - type: textarea + id: bug-steps + attributes: + label: How to reproduce? + description: | + Step by step explanation to reproduce the issue. + + If you can, drag and drop: + - a zipped sample notebook + - screenshots or a screencast showing the issue + placeholder: | + 1. Add a note with the content "..." + 2. Run `:ZKNew` + 3. See error + ... + validations: + required: true + - type: textarea + id: zk-config + attributes: + label: zk configuration + description: | + Paste the minimal `zk` configuration file (`.zk/config.toml`) reproducing the issue. + render: toml + validations: + required: true + - type: textarea + id: vim-config + attributes: + label: Neovim configuration + description: | + Paste the minimal Neovim configuration file (`init.vim` or `init.lua`) reproducing the issue. + render: viml + validations: + required: true + - type: textarea + id: bug-environment + attributes: + label: Environment + description: | + Run the following shell commands and paste the result here: + ``` + zk --version && echo "system: `uname -srmo`" && nvim --version + ``` + placeholder: | + zk 0.13.0 + system: Darwin 22.5.0 arm64 + NVIM v0.9.0 + Build type: Release + LuaJIT 2.1.0-beta3 + + system vimrc file: "$VIM/sysinit.vim" + fall-back for $VIM: "/opt/homebrew/Cellar/neovim/0.9.0/share/nvim" + + Run :checkhealth for more info + render: bash diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..e004602 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,10 @@ +name: Feature request +description: Suggest an idea for this project. +body: + - type: checkboxes + id: checks + attributes: + label: If you have an idea, open a discussion + options: + - label: I will [create a new discussion](https://github.com/mickael-menu/zk-nvim/discussions/new?category=ideas) instead of an issue. + diff --git a/.github/ISSUE_TEMPLATE/support.yml b/.github/ISSUE_TEMPLATE/support.yml new file mode 100644 index 0000000..4158079 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/support.yml @@ -0,0 +1,13 @@ +name: User support +description: You need help? +body: + - type: markdown + attributes: + value: | + :warning: Unfortunately, my time is limited and I can't offer reliable user support. I might answer if you catch me on a slow day, or hopefully someone else will. + - type: checkboxes + id: checks + attributes: + label: If you need help, open a discussion + options: + - label: I will [create a new discussion](https://github.com/mickael-menu/zk-nvim/discussions/new?category=help) instead of an issue.