docs: create issue template
This will help enforce a minimum amount of necessary information, and also help with automatic labeling.
This commit is contained in:
parent
38cb60ccda
commit
95b08f107a
3 changed files with 65 additions and 0 deletions
41
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
41
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
|
|
@ -0,0 +1,41 @@
|
|||
name: Bug Report
|
||||
description: Report a problem
|
||||
labels: [bug]
|
||||
body:
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: "Problem"
|
||||
description: "Describe the current behavior. May include logs, images, or videos."
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: "Steps to reproduce"
|
||||
placeholder: |
|
||||
git clone --depth=1 https://github.com/tree-sitter/tree-sitter-ruby
|
||||
cd tree-sitter-ruby
|
||||
tree-sitter generate
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: "Expected behavior"
|
||||
description: "Describe the behavior you expect."
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: input
|
||||
attributes:
|
||||
label: "Tree-sitter version (tree-sitter --version)"
|
||||
placeholder: "tree-sitter 0.20.9"
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: input
|
||||
attributes:
|
||||
label: "Operating system/version"
|
||||
placeholder: "macOS 11.5"
|
||||
validations:
|
||||
required: true
|
||||
1
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
1
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
|
|
@ -0,0 +1 @@
|
|||
blank_issues_enabled: false
|
||||
23
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Normal file
23
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Normal file
|
|
@ -0,0 +1,23 @@
|
|||
name: Feature request
|
||||
description: Request an enhancement
|
||||
labels: [enhancement]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Before requesting: search [existing feature requests](https://github.com/tree-sitter/tree-sitter/labels/enhancement).
|
||||
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: "Problem"
|
||||
description: "Describe the problem to be solved."
|
||||
placeholder: "No smurf icons available. Smurfs are useful because ..."
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: "Expected behavior"
|
||||
description: "Describe what the new feature or behavior would look like. How does it solve the problem? Is it worth the cost?"
|
||||
validations:
|
||||
required: false
|
||||
Loading…
Add table
Add a link
Reference in a new issue