Skip to content

Commit

Permalink
📚 DOCS improvement (#778)
Browse files Browse the repository at this point in the history
  • Loading branch information
chrisjsewell authored Jun 6, 2023
1 parent 3a6bbb1 commit 4d49023
Show file tree
Hide file tree
Showing 4 changed files with 99 additions and 0 deletions.
57 changes: 57 additions & 0 deletions .github/ISSUE_TEMPLATE/1-bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
name: Bug Report
description: Create a bug report 🐛
labels: ['bug']
body:
- type: markdown
attributes:
value: Thank you for taking the time to file a bug report! Please fill out this form as completely as possible.
- type: input
attributes:
label: What version of `myst-parser` are you using?
description: 'For example: 1.0.0'
validations:
required: true
- type: textarea
attributes:
label: What version dependencies are you using?
description: 'e.g. for docutils and sphinx'
validations:
required: true
- type: dropdown
id: os
attributes:
label: What operating system are you using?
options:
- Mac
- Windows
- Linux
- Other
validations:
required: true
- type: textarea
attributes:
label: Describe the Bug
description: A clear and concise description of the bug.
validations:
required: true
- type: textarea
attributes:
label: Expected Behavior
description: A clear and concise description of what you expected to happen.
validations:
required: false
- type: textarea
attributes:
label: To Reproduce
description: Steps to reproduce the behavior, please provide clear and concise steps.
validations:
required: false
- type: markdown
attributes:
value: Please ensure the steps you've provided reproduce the issue to the best of your ability.
- type: markdown
attributes:
value: Ideally, maintainers should be able to follow the steps provided in order to reproduce the bug.
- type: markdown
attributes:
value: Thank you for helping out the MyST team, these issues are what makes MyST better!!
21 changes: 21 additions & 0 deletions .github/ISSUE_TEMPLATE/2-feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
name: Feature Request
description: Request a new feature ✨
labels: ['enhancement']
body:
- type: markdown
attributes:
value: Thank you for taking the time to submit a feature request! Please fill out this form as completely as possible.
- type: textarea
attributes:
label: Describe the feature you'd like to request
description: A clear and concise description of what you want and what your use case is.
validations:
required: true
- type: textarea
attributes:
label: Describe the solution you'd like
description: A clear and concise description of what you want to happen.
- type: textarea
attributes:
label: Describe alternatives you've considered
description: A clear and concise description of any alternative solutions or features you've considered.
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/3-documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
name: Feature Request
description: Suggest improvements to the documentation 📖
labels: ['documentation']
body:
- type: markdown
attributes:
value: Thank you for taking the time to submit a suggestion! Please fill out this form as completely as possible.
- type: textarea
attributes:
label: Describe the gap in the current documentation
description: A clear and concise description of what area is currently missing or unclear.
validations:
required: true
- type: textarea
attributes:
label: Describe the solution you'd like
description: A clear and concise description of what you would like to see in the documentation.
4 changes: 4 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
contact_links:
- name: Ask a question 💬
url: https://github.com/executablebooks/MyST-Parser/discussions
about: Ask questions and discuss ideas with other community members

0 comments on commit 4d49023

Please sign in to comment.