Issue template for documentation improvements (#1732)
The existing issue templates don't fit well for "the docs are not very good" and are too high friction. This is intended as a very-low friction tool to provide the basis for more thorough docs PRs.
This commit is contained in:
parent
50df6b61f2
commit
203c7c1aca
2
.github/ISSUE_TEMPLATE/bug_report.md
vendored
2
.github/ISSUE_TEMPLATE/bug_report.md
vendored
@ -2,7 +2,7 @@
|
||||
name: Bug Report
|
||||
about: Report a bug to help us improve!
|
||||
title: ''
|
||||
labels: ''
|
||||
labels: bug, needs-triage
|
||||
assignees: ''
|
||||
---
|
||||
|
||||
|
||||
13
.github/ISSUE_TEMPLATE/docs_improvement.md
vendored
Normal file
13
.github/ISSUE_TEMPLATE/docs_improvement.md
vendored
Normal file
@ -0,0 +1,13 @@
|
||||
---
|
||||
name: Docs Improvement
|
||||
about: Help us write better docs to catch common issues!
|
||||
title: ''
|
||||
labels: documentation, needs-triage
|
||||
assignees: ''
|
||||
---
|
||||
|
||||
## How can Bevy's documentation be improved?
|
||||
|
||||
Provide a link to the documentation and describe how it could be improved. In what ways is it incomplete, incorrect, or misleading?
|
||||
|
||||
If you have suggestions on exactly what the new docs should say, feel free to include them here. Or alternatively, make the changes yourself and [create a pull request](https://bevyengine.org/learn/book/contributing/code/) instead.
|
||||
2
.github/ISSUE_TEMPLATE/feature_request.md
vendored
2
.github/ISSUE_TEMPLATE/feature_request.md
vendored
@ -2,7 +2,7 @@
|
||||
name: Feature Request
|
||||
about: Propose a new feature!
|
||||
title: ''
|
||||
labels: ''
|
||||
labels: enhancement, needs-triage
|
||||
assignees: ''
|
||||
---
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user