Add specific repository issue templates

This commit is contained in:
Tobie Morgan Hitchcock 2021-12-14 10:28:00 +00:00
parent e2dd969886
commit 411bc7c3a2
4 changed files with 171 additions and 1 deletions

67
.github/ISSUE_TEMPLATE/bug_report.yml vendored Normal file
View file

@ -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

View file

@ -2,4 +2,7 @@ blank_issues_enabled: false
contact_links: contact_links:
- name: Question or idea - name: Question or idea
url: https://github.com/surrealdb/surrealdb/discussions 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.

View file

@ -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

View file

@ -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