Skip to content

Commit 0a5daf2

Browse files
authored
Update issue templates (#960)
* Update issue templates * Remove unused templates. * Formatting
1 parent 15589e4 commit 0a5daf2

File tree

5 files changed

+91
-20
lines changed

5 files changed

+91
-20
lines changed

.github/ISSUE_TEMPLATE/bug-report.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
name: Bug report
3+
about: Unrelated to the OpenAPI schema (Node error, etc.)
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Description**
11+
12+
_A brief description of the bug._
13+
14+
```
15+
Paste full error message
16+
```
17+
18+
| Name | Version |
19+
|:---------------------|:-----------------------------|
20+
| `openapi-typescript` | `x.x.x` |
21+
| Node.js | `x.x.x` |
22+
| OS + version | `macOS 13, Windows 11, etc.` |
23+
24+
**Reproduction**
25+
26+
_How can this be reproduced / when did the error occur?_
27+
28+
**Expected result**
29+
30+
_(in case it’s not obvious)_
31+
32+
**Checklist**
33+
34+
- [ ] I’m willing to open a PR (see [CONTRIBUTING.md](https://github.com/drwpow/openapi-typescript/blob/main/CONTRIBUTING.md))

.github/ISSUE_TEMPLATE/bug.md

Lines changed: 0 additions & 10 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/feature.md

Lines changed: 0 additions & 10 deletions
This file was deleted.
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Add missing functionality
4+
title: ''
5+
labels: enhancement, help wanted
6+
assignees: ''
7+
8+
---
9+
10+
**Description**
11+
12+
_Brief description of the problem you’re trying to solve, and why this could be useful._
13+
14+
**Proposal**
15+
16+
_Outline the change to the library. If this is for the CLI, propose a flag name and/or workflow. If this is for Node API, propose how this would be consumed. Reference any prior art or similar examples._
17+
18+
**Checklist**
19+
20+
- [ ] I’m willing to open a PR for this (see [CONTRIBUTING.md](https://github.com/drwpow/openapi-typescript/blob/main/CONTRIBUTING.md))
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
name: Unsupported schema syntax
3+
about: Part of the OpenAPI spec isn’t generating as expected (or at all)
4+
title: ''
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
**Description**
11+
12+
_A brief description of the issue. _
13+
14+
_[Link to the OpenAPI version & spec description](#)_
15+
16+
**OpenAPI**
17+
18+
```yaml
19+
# Your OpenAPI schema (can be a stub)
20+
```
21+
22+
**Generated TS**
23+
24+
```ts
25+
// What’s generated in the current version (or put “nothing” if it’s skipped)
26+
```
27+
28+
**Expected TS*
29+
30+
```ts
31+
// What you’d like to see generated
32+
```
33+
34+
**Checklist**
35+
36+
- [ ] My OpenAPI schema passes a validator
37+
- [ ] I’m willing to open a PR for this (see [CONTRIBUTING.md](https://github.com/drwpow/openapi-typescript/blob/main/CONTRIBUTING.md))

0 commit comments

Comments
 (0)