Skip to content

Commit dbc4996

Browse files
committed
Update bug report template
1 parent fe40564 commit dbc4996

File tree

1 file changed

+34
-14
lines changed

1 file changed

+34
-14
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 34 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,34 +4,57 @@ about: Create a report to help us improve
44
title: ''
55
labels: bug
66
assignees: rigwild
7-
87
---
98

109
## Describe the bug
10+
1111
A clear and concise description of what the bug is.
1212

1313
## Reproduce
14+
1415
### Usage
16+
1517
Used `apidoc-markdown` command or script.
1618

1719
```bash
18-
apidoc-markdown -p ./example/basic -o ./example/basic/example.md
20+
apidoc-markdown --debug -p ./example/basic -o ./example/basic/example.md
1921
```
2022

2123
```ts
2224
import { generateMarkdown } from 'apidoc-markdown'
2325

2426
const documentation = await generateMarkdown({
25-
apiDocProjectData: { name: 'test', version: '0.13.0', /* ... */ },
26-
apiDocApiData: [{ type: 'get', url: '/define', /* ... */ }],
27+
apiDocProjectData: { name: 'test', version: '0.13.0' /* ... */ },
28+
apiDocApiData: [{ type: 'get', url: '/define' /* ... */ }],
2729
template: 'my EJS template <%= project.name %> v<%= project.version %>',
2830
prepend: 'Prepend this!',
2931
multi: false
3032
})
3133
```
3234

35+
### Sample code
36+
37+
Some sample code to reproduce the issue.
38+
39+
```js
40+
/**
41+
* @api {get} /test Get a test
42+
* @apiName GetTest
43+
* @apiGroup Test
44+
*/
45+
function testGet() {}
46+
47+
/**
48+
* @api {post} /test Post a test
49+
* @apiName PostTest
50+
* @apiGroup Test
51+
*/
52+
function testPost() {}
53+
```
54+
3355
### `api_project.json`
34-
Used `api_project.json` file.
56+
57+
Used `api_project.json` file (to get this file, run your command with `-d` or `--debug`).
3558

3659
```json
3760
{
@@ -48,10 +71,7 @@ Used `api_project.json` file.
4871
"title": "My own footer title",
4972
"content": "<h1>Footer .md File</h1>\n<p>Content of footer.md file.</p>\n"
5073
},
51-
"order": [
52-
"Markdown",
53-
"Example"
54-
],
74+
"order": ["Markdown", "Example"],
5575
"defaultVersion": "0.0.0",
5676
"apidoc": "0.3.0",
5777
"generator": {
@@ -64,7 +84,8 @@ Used `api_project.json` file.
6484
```
6585

6686
### `api_data.json`
67-
Used `api_data.json` file.
87+
88+
Used `api_data.json` file (to get this file, run your command with `-d` or `--debug`).
6889

6990
```json
7091
[
@@ -115,10 +136,9 @@ Used `api_data.json` file.
115136
A clear and concise description of what you expected to happen.
116137

117138
**Versions (please complete the following information):**
118-
- `Node.js` version: `complete_this` [e.g. `13.9.0`]
119-
- `TypeScript` version: `complete_this` [e.g. `13.9.0`]
120-
- `apiDoc` version: `complete_this` [e.g. `0.20.0`]
121-
- `apidoc-markdown` version: `complete_this` [e.g. `1.12.3`]
139+
140+
- `Node.js` version: `13.9.0`
141+
- `apidoc-markdown` version: `1.12.3`
122142

123143
**Additional context**
124144
Add any other context about the problem here.

0 commit comments

Comments
 (0)