From 411bc7c3a2a8f3b249133dc89bf3ab5ce9ea6f9c Mon Sep 17 00:00:00 2001 From: Tobie Morgan Hitchcock Date: Tue, 14 Dec 2021 10:28:00 +0000 Subject: [PATCH] Add specific repository issue templates --- .github/ISSUE_TEMPLATE/bug_report.yml | 67 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 5 +- .github/ISSUE_TEMPLATE/documentation.yml | 33 +++++++++++ .github/ISSUE_TEMPLATE/feature_request.yml | 67 ++++++++++++++++++++++ 4 files changed, 171 insertions(+), 1 deletion(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/documentation.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..ca8a5d4c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,67 @@ +name: Bug report +description: File a bug report +title: "Bug: " +labels: ["bug", "triage"] +assignees: + - octocat +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + - type: textarea + id: what + attributes: + label: Describe the bug + description: What exactly is going wrong? + placeholder: A short description of what the bug is. + validations: + required: true + - type: textarea + id: steps + attributes: + label: Steps to reproduce + description: What are the steps necessary to reproduce this bug? + placeholder: Detail the steps taken to reproduce the behaviour. + validations: + required: true + - type: textarea + id: expected + attributes: + label: Expected behaviour + description: What is the behaviour that you would expect to see? + placeholder: A clear and concise description of what you expected to happen. + validations: + required: true + - type: input + id: version + attributes: + label: SurrealDB version + description: Copy and paste the output of `surreal version` + placeholder: surreal 0.0.0 for macOS on aarch64 + validations: + required: true + - type: input + id: contact + attributes: + label: Contact Details + description: How can we get in touch with you if we need more info? + placeholder: email@example.com + validations: + required: false + - type: checkboxes + id: check + attributes: + label: Is there an existing issue for this? + description: Please search [our issues](https://github.com/surrealdb/surrealdb/issues) to see if this bug already exists. + options: + - label: I have searched the existing issues + required: true + - type: checkboxes + id: terms + attributes: + label: Code of Conduct + description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/surrealdb/surrealdb) + options: + - label: I agree to follow this project's Code of Conduct + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index e8b98921..235e3e62 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -2,4 +2,7 @@ blank_issues_enabled: false contact_links: - name: Question or idea url: https://github.com/surrealdb/surrealdb/discussions - about: Ask questions and discuss ideas. + about: Ask questions and discuss ideas here. + - name: Security issues + url: https://surrealdb.com/security + about: Report security vulnerabilities here. diff --git a/.github/ISSUE_TEMPLATE/documentation.yml b/.github/ISSUE_TEMPLATE/documentation.yml new file mode 100644 index 00000000..1ef0cf7b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.yml @@ -0,0 +1,33 @@ +name: Documentation +description: Report an issue related to documentation +title: "Documentation: " +labels: [documentation] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to make our documentation better! + - type: textarea + id: description + validations: + required: true + attributes: + label: Description + description: What should be changed in the docs? + placeholder: A clear and concise description of how the documentation should be updated. + - type: checkboxes + id: check + attributes: + label: Is there an existing issue for this? + description: Please search [our issues](https://github.com/surrealdb/surrealdb/issues) to see if this bug already exists. + options: + - label: I have searched the existing issues + required: true + - type: checkboxes + id: terms + attributes: + label: Code of Conduct + description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/surrealdb/surrealdb) + options: + - label: I agree to follow this project's Code of Conduct + required: true \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 00000000..6a75f1e4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,67 @@ +name: Feature request +description: File a feature request +title: "Feature: " +labels: ["feature", "triage"] +assignees: + - octocat +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to suggest an idea for SurrealDB! + - type: textarea + id: problem + attributes: + label: Is your feature request related to a problem? + description: What is the usecase in which this feature is relevant? + placeholder: A clear and concise description of what the problem is. + validations: + required: true + - type: textarea + id: solution + attributes: + label: Describe the solution + description: Describe the solution and how it might work. + placeholder: A clear and concise description of what you want to happen. + validations: + required: true + - type: textarea + id: alternatives + attributes: + label: Alternative methods + description: Describe alternatives you've considered. + placeholder: A clear and concise description of any alternative solutions or features you've considered. + validations: + required: true + - type: input + id: version + attributes: + label: SurrealDB version + description: Copy and paste the output of `surreal version` + placeholder: surreal 0.0.0 for macOS on aarch64 + validations: + required: true + - type: input + id: contact + attributes: + label: Contact Details + description: How can we get in touch with you if we need more info? + placeholder: email@example.com + validations: + required: false + - type: checkboxes + id: check + attributes: + label: Is there an existing issue for this? + description: Please search [our issues](https://github.com/surrealdb/surrealdb/issues) to see if this bug already exists. + options: + - label: I have searched the existing issues + required: true + - type: checkboxes + id: terms + attributes: + label: Code of Conduct + description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/surrealdb/surrealdb) + options: + - label: I agree to follow this project's Code of Conduct + required: true