|
1 | 1 | --- |
2 | | -name: Bug report |
3 | | -about: Tell about typedoc's bug |
| 2 | +name: Bug Report |
| 3 | +about: Report a bug in TypeDoc |
4 | 4 | labels: bug |
5 | 5 | --- |
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 | | ---> |
13 | 6 |
|
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 --> |
15 | 9 |
|
16 | 10 | ## Expected Behavior |
17 | | -<!-- |
18 | | - According to your expectations, how is Typedoc supposed to work? |
19 | | ---> |
| 11 | +<!-- How did you expect Typedoc to work? --> |
20 | 12 |
|
21 | 13 | ## Actual Behavior |
22 | | -<!-- |
23 | | - What does Typedoc fail to do? |
24 | | ---> |
| 14 | +<!-- What does Typedoc fail to do? --> |
25 | 15 |
|
26 | 16 | ## Steps to reproduce the bug |
27 | 17 | <!-- |
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 |
33 | 25 | --> |
34 | 26 |
|
35 | 27 | ## Environment |
36 | | - - Typedoc version: |
37 | | - - Node.js version: |
38 | | - - OS: |
| 28 | +- Typedoc version: |
| 29 | +- TypeScript version: |
| 30 | +- Node.js version: |
| 31 | +- OS: |
0 commit comments