diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 3ce6febb..00000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: "[Bug]: " -labels: 'bug :bug:' -assignees: '' ---- - -NOTE: for setup help, general "how do I use this?", or other simple things, please use [Discussions](https://github.com/NRCHKB/node-red-contrib-homekit-bridged/discussions). Issues are reserved for feature requests, bugs, and security issues in the code. - -**Describe the bug** -A clear and concise description of what the bug is. - -**To Reproduce** -Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Desktop (please complete the following information):** - - OS: [e.g. Rpi, Docker] - - Node version: [run `node -v` in terminal] - - NPM version: [run `npm -v` in terminal] - - NodeRed version: - - NRCHKB Plugin Version: [found in pallette manager] - -**Additional context** -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml new file mode 100644 index 00000000..d0846413 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -0,0 +1,96 @@ +name: Bug report +description: Create a bug report to help us improve +title: "[Bug]: " +labels: ["bug :bug:"] +assignees: + - shaquu +body: + - type: markdown + attributes: + value: + Please fill in as much information as you are able, everything helps to diagnose bugs. + - type: input + id: NRCHKBPluginVersion + attributes: + label: NRCHKB Plugin Version + description: Find version number in Pallet Manager + placeholder: ex. 1.3.6 + validations: + required: true + - type: input + id: NodeVersion + attributes: + label: Node JS Version + description: Run `node -v` in terminal + placeholder: ex. 14.17.1 + validations: + required: true + - type: input + id: NPMVersion + attributes: + label: NPM Version + description: Run `npm -v` in terminal + placeholder: ex. 6.14.13 + validations: + required: true + - type: input + id: NRVersion + attributes: + label: Node-RED Version + description: Find in the top-right menu in Node-RED flows setup + placeholder: ex. 2.0.1 + validations: + required: true + - type: input + id: OS + attributes: + label: Operating System + description: Raspberry pi, Docker, Ubuntu, etc. + placeholder: ex. Raspberry pi Buster + validations: + required: true + - type: textarea + id: what-happened + attributes: + label: What happened? + description: "Please describe observed behavior and expected behavior:" + placeholder: Tell us what you see! + value: "A bug happened! Please describe the problem, drag pictures here if they are helpful to your story." + validations: + required: true + - type: textarea + id: reproduce + attributes: + label: How to reproduce? + description: Steps to reproduce the behavior. + placeholder: Reproduce! + value: "Steps to reproduce the behavior: + 1. Go to '...' + 2. Click on '....' + 3. Scroll down to '....' + 4. See error" + validations: + required: true + - type: textarea + id: expected + attributes: + label: "Expected behavior:" + description: What should happen? + placeholder: expected + value: Describe expected behavior here, with relevant screenshots if they would help. + validations: + required: false + - type: textarea + id: other + attributes: + label: Additional comments? + placeholder: expected + value: Additional comments here, if any. + validations: + required: false + - type: textarea + id: logs + attributes: + label: Relevant log output + description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. + render: shell diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 90621b1a..00000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: "[Feature Request]: " -labels: 'enhancement :+1:' -assignees: '' ---- - -NOTE: for setup help, general "how do I use this?", or other simple things, please use [Discussions](https://github.com/NRCHKB/node-red-contrib-homekit-bridged/discussions). Issues are reserved for feature requests, bugs, and security issues in the code. - -**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/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml new file mode 100644 index 00000000..b6aa29ec --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yaml @@ -0,0 +1,58 @@ +name: Feature request +description: If you have an idea for a new feature +title: "[Feature]: " +labels: ["enhancement :+1:"] +assignees: + - shaquu + - crxporter +body: + - type: markdown + attributes: + value: + We love new ideas! + - type: input + id: NRCHKBPluginVersion + attributes: + label: Your Current NRCHKB Plugin Version + description: Find version number in Pallet Manager + placeholder: ex. 1.3.6 + validations: + required: false + - type: input + id: OS + attributes: + label: Operating System + description: Raspberry pi, Docker, Ubuntu, etc. + placeholder: ex. Raspberry pi Buster + validations: + required: false + - type: textarea + id: feature_description + attributes: + label: What is your idea? + description: "Please describe your feature here:" + placeholder: Tell us what you want! + value: "Please describe your idea, drag screenshots or drawings here if they help your explanation." + validations: + required: true + - type: textarea + id: extra_info + attributes: + label: Any more details? + value: "If this is specific to some hardware or specific software version, please explain here." + validations: + required: false + - type: textarea + id: other + attributes: + label: Additional comments? + placeholder: expected + value: Additional comments here, if any. + validations: + required: false + - type: textarea + id: logs + attributes: + label: Any code or functions to add? + description: Please copy and paste any relevant code. This will be automatically formatted into code, so no need for backticks. + render: shell diff --git a/.github/ISSUE_TEMPLATE/need_help.yaml b/.github/ISSUE_TEMPLATE/need_help.yaml new file mode 100644 index 00000000..2b9a6282 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/need_help.yaml @@ -0,0 +1,54 @@ +name: Need help +description: Click it if you need help +title: "[Help needed]: " +labels: ["question"] +assignees: + - crxporter +body: + - type: markdown + attributes: + value: '## If you need help with your setup please consider using [Discussions](https://github.com/NRCHKB/node-red-contrib-homekit-bridged/discussions)' + - type: markdown + attributes: + value: 'Additional live help is available on our [Discord channel](https://discord.gg/uvYac5u)' + - type: input + id: NRCHKBPluginVersion + attributes: + label: Your Current NRCHKB Plugin Version + description: Find version number in Pallet Manager + placeholder: ex. 1.3.6 + validations: + required: false + - type: input + id: OS + attributes: + label: Operating System + description: Raspberry pi, Docker, Ubuntu, etc. + placeholder: ex. Raspberry pi Buster + validations: + required: false + - type: textarea + id: neel_help + attributes: + label: How can we help? + description: "Please describe what you are struggling with:" + placeholder: Tell us what you want! + value: "Ask your question here, drag screenshots or drawings here if they help." + validations: + required: true + - type: textarea + id: extra_info + attributes: + label: Any more details? + value: "If this is specific to some hardware or specific software version, please explain here." + validations: + required: false + - type: textarea + id: logs + attributes: + label: Any code or functions to add? + description: Please copy and paste any relevant code. This will be automatically formatted into code, so no need for backticks. + render: shell + - type: markdown + attributes: + value: '## One more request to please consider using [Discussions](https://github.com/NRCHKB/node-red-contrib-homekit-bridged/discussions).'