Skip to content

Commit

Permalink
chore(global): added issue template
Browse files Browse the repository at this point in the history
  • Loading branch information
tgreyuk committed May 3, 2024
1 parent 616ec5a commit 80c651f
Show file tree
Hide file tree
Showing 3 changed files with 73 additions and 0 deletions.
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: Bug report
description: Create a bug report.
labels: [bug]
body:
- type: dropdown
attributes:
label: What package is the bug related to?
multiple: false
options:
- "typedoc-plugin-markdown"
- "typedoc-plugin-frontmatter"
- "typdedoc-plugin-remark"
- "typedoc-vitepress-theme"
- "typedoc-github-wiki-theme"
- "typedoc-gitlab-wiki-theme"
- "docusaurus-plugin-typedoc"
default: 0
validations:
required: true
- type: textarea
attributes:
label: Describe the issue
description: Please describe what the issue and provide as many details as possible.
validations:
required: true
- type: textarea
attributes:
label: TypeDoc configuration
description: Please provide TypeDoc and plugin versions and your options file or list of options you have set.
validations:
required: false
- type: textarea
attributes:
label: Expected behavior
description: Please describe what the expected behaviour should be.
validations:
required: false
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Ask a question
url: https://github.com/typedoc2md/typedoc-plugin-markdown/discussions/categories/q-a
about: Ask a question on the discussions board.
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: Feature request
description: Create a feature request.
labels: [enhancement]
body:
- type: dropdown
attributes:
label: What package is the feature request related to?
multiple: false
options:
- 'typedoc-plugin-markdown'
- 'typedoc-plugin-frontmatter'
- 'typdedoc-plugin-remark'
- 'typedoc-vitepress-theme'
- 'typedoc-github-wiki-theme'
- 'typedoc-gitlab-wiki-theme'
- 'docusaurus-plugin-typedoc'
default: 0
validations:
required: true
- type: textarea
attributes:
label: Background
description: Please describe what the desired new feature is aiming to resolve (provide as many details as possible).
validations:
required: true
- type: textarea
attributes:
label: Proposed solution
description: Please describe what the proposed solution you would like to see.
validations:
required: false

0 comments on commit 80c651f

Please sign in to comment.