Skip to content

Commit

Permalink
add doc issue template: by create documentation.yml
Browse files Browse the repository at this point in the history
  • Loading branch information
QG-phy authored Sep 14, 2023
1 parent 50e646f commit 2662f85
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: Docs
description: For users or developers to report issues related to software documentation, such as missing or incomplete documentation, or documentation that is difficult to understand.
labels: [Docs]
assignees: Qiangqiang Gu
body:
- type: textarea
attributes:
label: Details
description: |
Please provide details about the documentation issue you are experiencing. Include any relevant information such as the specific section of the documentation, the information that is missing or unclear, and any suggestions for improvement.
placeholder: |
Example: The documentation for the band structure calculations is missing. I have read the online manual, but I am still not sure how to do it. My suggestion is to add a new section to the online manual that describes this.
validations:
required: true
- type: markdown
attributes:
value: >
Thank you for reporting this documentation issue. We will review and update the documentation as necessary. 📚

0 comments on commit 2662f85

Please sign in to comment.