Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add new issue template #676

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation_template.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
name: Documentation request 📖
description: Suggest new documentation or improvements to existing documentation
labels: [documentation, untriaged]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to submit a documentation request!
- type: textarea
id: suggestion
attributes:
label: Is there a problem with the current documentation
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Please provide details on how and where the documentation can be improved"

description: A clear and concise description of what the problem is. Ex. I'm unable to find documentation on [...]
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

description of the issue. For instance, "I'm unable to find documentation on [...]"

validations:
required: true
- type: textarea
id: references
attributes:
label: Provide references
description: List out links to existing documentation if applicable
- type: textarea
id: additional-context
attributes:
label: Additional context
description: Add any other context or screenshots about the documentation request here.
Loading