Skip to content

Commit

Permalink
add documentation issue template
Browse files Browse the repository at this point in the history
  • Loading branch information
ianhi committed Feb 7, 2021
1 parent 930ff1b commit cc45bd6
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
name: Documentation improvement
about: Create a report to help us improve the documentation
labels: doc
---

<!--To help us understand and resolve your issue, please fill out the form to the best of your ability.-->
<!--You can feel free to delete the sections that do not apply.-->

### Problem

<!--
If you are referencing an existing piece of documentation or example please provide a link.
* I found [...] to be unclear because [...]
* [...] made me think that [...] when really it should be [...]
* There is no example showing how to do [...]
-->


### Suggested Improvement

<!--
If you have an idea to improve the documentation please suggest it here
* This line should be be changed to say [...]
* Include a paragraph explaining [...]
* Add a figure showing [...]
-->

0 comments on commit cc45bd6

Please sign in to comment.