Skip to content

Commit 532a621

Browse files
committed
chore: Update issue templates
Closes #1236
1 parent d3af643 commit 532a621

File tree

3 files changed

+27
-39
lines changed

3 files changed

+27
-39
lines changed
Lines changed: 17 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,31 @@
11
---
2-
name: Bug report
3-
about: Tell about typedoc's bug
2+
name: Bug Report
3+
about: Report a bug in TypeDoc
44
labels: bug
55
---
6-
<!--
7-
Thank you for contributing to Typedoc!
8-
9-
First, please use a clear and descriptive title for the issue to identify the bug.
10-
11-
Please be as specific as possible! Provide codes, screenshots, repositories, explanations, issues, links ... anything that could describe your point.
12-
-->
136

14-
- [ ] I have checked [issues with bug label](https://github.com/TypeStrong/typedoc/labels/bug) and found no duplicates
7+
## Search terms
8+
<!-- Include keywords that might help others with the same problem find this issue -->
159

1610
## Expected Behavior
17-
<!--
18-
According to your expectations, how is Typedoc supposed to work?
19-
-->
11+
<!-- How did you expect Typedoc to work? -->
2012

2113
## Actual Behavior
22-
<!--
23-
What does Typedoc fail to do?
24-
-->
14+
<!-- What does Typedoc fail to do? -->
2515

2616
## Steps to reproduce the bug
2717
<!--
28-
Tell us how we could reproduce the bug. Possible ways are providing:
29-
- Typedoc command (typedoc --out ...)
30-
- Configuration (typedoc.js or your custom option file)
31-
- Code that causes a bug in the documentation generated
32-
- Project (Github repository, CodePen, ...) where the issue can be reproduced.
18+
If possible, please create a *minimal* repo reproducing your problem and link it.
19+
20+
If this is not possible, include at least:
21+
1. Installed packages + versions
22+
2. The code TypeDoc doesn't work on
23+
3. tsconfig.json
24+
4. How you are running TypeDoc + any relevant configuration files
3325
-->
3426

3527
## Environment
36-
- Typedoc version:
37-
- Node.js version:
38-
- OS:
28+
- Typedoc version:
29+
- TypeScript version:
30+
- Node.js version:
31+
- OS:
Lines changed: 6 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,14 @@
11
---
22
name: Feature Request
3-
about: Suggest an improvement or a feature
3+
about: Suggest improvements or new features
4+
labels: enhancement
45
---
5-
<!--
6-
Thank you for contributing to Typedoc!
7-
8-
First, please use a clear and descriptive title for the issue to identify the suggestion.
9-
10-
Please be as specific as possible! Provide codes, screenshots, repositories, explanations, issues, links ... anything that could describe your point.
11-
-->
126

13-
- [ ] I have checked [issues with enhancement label](https://github.com/TypeStrong/typedoc/labels/enhancement) and found no duplicates
7+
## Search Terms
8+
<!-- Include keywords that might help others with the same problem find this issue -->
149

1510
## Problem
16-
<!--
17-
What is missing or inconvenient without this improvement or feature?
18-
-->
11+
<!-- What is missing or inconvenient without this improvement or feature? -->
1912

2013
## Suggested Solution
21-
<!--
22-
How do you suggest fixing the problem?
23-
-->
14+
<!-- How do you suggest fixing the problem? Do any other tools already do it? -->

.github/ISSUE_TEMPLATE/other.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
name: Other Issue
3+
about: If the other templates don't fit...
4+
---

0 commit comments

Comments
 (0)