From 24889f6f3f0374b8fa6d6206b6b94196012be3a8 Mon Sep 17 00:00:00 2001 From: dnth Date: Tue, 18 Apr 2023 11:16:22 +0800 Subject: [PATCH 1/5] basic template --- .github/ISSUE_TEMPLATE/bug-report.yml | 60 +++++++++++++++++++++++++++ 1 file changed, 60 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yml diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 00000000..deb5fb81 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,60 @@ +name: Bug Report +description: File a bug report +title: "[Bug]: " +labels: ["bug"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + - type: input + id: contact + attributes: + label: Contact Details + description: How can we get in touch with you if we need more info? + placeholder: ex. email@example.com + validations: + required: false + - type: textarea + id: what-happened + attributes: + label: What happened? + description: Also tell us, what did you expect to happen? + placeholder: Tell us what you see! + value: "A bug happened!" + validations: + required: true + - type: dropdown + id: version + attributes: + label: Version + description: What version of our software are you running? + options: + - 1.0.2 (Default) + - 1.0.3 (Edge) + validations: + required: true + - type: dropdown + id: browsers + attributes: + label: What browsers are you seeing the problem on? + multiple: true + options: + - Firefox + - Chrome + - Safari + - Microsoft Edge + - 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 + - type: checkboxes + id: terms + attributes: + label: Code of Conduct + description: By submitting this issue, you agree to follow our [Code of Conduct](https://example.com) + options: + - label: I agree to follow this project's Code of Conduct + required: true \ No newline at end of file From 6e5b97edf5b15887b4d7bb4292f79e272aca705a Mon Sep 17 00:00:00 2001 From: dnth Date: Tue, 18 Apr 2023 11:20:38 +0800 Subject: [PATCH 2/5] add config --- .github/ISSUE_TEMPLATE/config.yml | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..8321b996 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,11 @@ +blank_issues_enabled: true +contact_links: + - name: Discussion Forum + url: https://visual-layer.readme.io/discuss + about: Ask questions and discuss. + - name: Slack Channel + url: https://visualdatabase.slack.com/join/shared_invite/zt-19jaydbjn-lNDEDkgvSI1QwbTXSY6dlA#/shared-invite/email + about: Chat with us. + - name: Documentation Page + url: https://visual-layer.readme.io/ + about: Read the docs. \ No newline at end of file From 4a8dc6c0225260686a1f7bd519d639bb6f198eab Mon Sep 17 00:00:00 2001 From: dnth Date: Tue, 18 Apr 2023 11:24:41 +0800 Subject: [PATCH 3/5] rename file --- .github/ISSUE_TEMPLATE/{bug-report.yml => bug_report.yml} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename .github/ISSUE_TEMPLATE/{bug-report.yml => bug_report.yml} (100%) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml similarity index 100% rename from .github/ISSUE_TEMPLATE/bug-report.yml rename to .github/ISSUE_TEMPLATE/bug_report.yml From 3aebfc84809af75a159c9fb2144363a516d49074 Mon Sep 17 00:00:00 2001 From: dnth Date: Tue, 18 Apr 2023 12:58:12 +0800 Subject: [PATCH 4/5] update issue template --- .github/ISSUE_TEMPLATE/bug_report.yml | 83 +++++++++++++++++---------- 1 file changed, 53 insertions(+), 30 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index deb5fb81..62c2a234 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -7,54 +7,77 @@ body: attributes: value: | Thanks for taking the time to fill out this bug report! - - type: input - id: contact - attributes: - label: Contact Details - description: How can we get in touch with you if we need more info? - placeholder: ex. email@example.com - validations: - required: false - type: textarea id: what-happened attributes: label: What happened? - description: Also tell us, what did you expect to happen? placeholder: Tell us what you see! - value: "A bug happened!" validations: required: true - - type: dropdown - id: version + - type: textarea + id: what-expected attributes: - label: Version - description: What version of our software are you running? - options: - - 1.0.2 (Default) - - 1.0.3 (Edge) + label: What did you expect to see? + placeholder: Tell us what you expect! + validations: + required: true + - type: input + id: fastdup-version + attributes: + label: What version of fastdup were you runnning on? + placeholder: ex. 0.918 validations: required: true - type: dropdown - id: browsers + id: python-version attributes: - label: What browsers are you seeing the problem on? + label: What version of Python were you running on? multiple: true options: - - Firefox - - Chrome - - Safari - - Microsoft Edge + - Python 3.10 + - Python 3.9 + - Python 3.8 + - Python 3.7 + - Other + validations: + required: true + - type: input + id: os-version + attributes: + label: Operating System + description: What operating system and version were you runnning on? + placeholder: ex. Ubuntu 22.04 LTS / macOS Ventura 13.3.1 (M1) / Windows 11 + validations: + required: true + - type: textarea + id: reproduce + attributes: + label: Reproduction steps + description: "How do you trigger this bug? Please walk us through it step by step." + placeholder: | + 1. Go to '...' + 2. Click on '....' + 3. Scroll down to '....' + 4. See error '...' + 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 - - type: checkboxes - id: terms + - type: textarea + id: screenshot attributes: - label: Code of Conduct - description: By submitting this issue, you agree to follow our [Code of Conduct](https://example.com) - options: - - label: I agree to follow this project's Code of Conduct - required: true \ No newline at end of file + label: Attach a screenshot [Optional] + validations: + required: true + - type: input + id: contact + attributes: + label: Contact Details [Optional] + description: How can we get in touch with you if we need more info? + placeholder: ex. email@example.com + validations: + required: true \ No newline at end of file From 4c099a84e1162f0910d366ea6133eea7899249a7 Mon Sep 17 00:00:00 2001 From: dnth Date: Tue, 18 Apr 2023 13:16:10 +0800 Subject: [PATCH 5/5] add feature req --- .github/ISSUE_TEMPLATE/feature_request.yml | 36 ++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 00000000..4e582cd4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,36 @@ +name: Feature Request +description: Suggest a new feature for the project +title: "[Feature Request]: " +labels: ["feature-request"] +body: + - type: markdown + attributes: + value: | + Thanks for suggesting a new feature for our project! Please fill out the following information so we can better understand your request. + - type: input + id: feature-name + attributes: + label: Feature Name + description: What do you want to call this feature? + placeholder: ex. Dark Mode + validations: + required: true + - type: textarea + id: feature-description + attributes: + label: Feature Description + description: Please describe the new feature in as much detail as possible. + placeholder: | + What does the feature do? + Why do you think it's important? + How will it benefit users? + validations: + required: true + - type: input + id: contact-info + attributes: + label: Contact Information [Optional] + description: How can we get in touch with you if we have questions or need more information? + placeholder: ex. email@example.com + validations: + required: false