Skip to content

Update issue templates #960

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Oct 30, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
name: Bug report
about: Unrelated to the OpenAPI schema (Node error, etc.)
title: ''
labels: ''
assignees: ''

---

**Description**

_A brief description of the bug._

```
Paste full error message
```

| Name | Version |
|:---------------------|:-----------------------------|
| `openapi-typescript` | `x.x.x` |
| Node.js | `x.x.x` |
| OS + version | `macOS 13, Windows 11, etc.` |

**Reproduction**

_How can this be reproduced / when did the error occur?_

**Expected result**

_(in case it’s not obvious)_

**Checklist**

- [ ] I’m willing to open a PR (see [CONTRIBUTING.md](https://github.com/drwpow/openapi-typescript/blob/main/CONTRIBUTING.md))
10 changes: 0 additions & 10 deletions .github/ISSUE_TEMPLATE/bug.md

This file was deleted.

10 changes: 0 additions & 10 deletions .github/ISSUE_TEMPLATE/feature.md

This file was deleted.

20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Feature request
about: Add missing functionality
title: ''
labels: enhancement, help wanted
assignees: ''

---

**Description**

_Brief description of the problem you’re trying to solve, and why this could be useful._

**Proposal**

_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._

**Checklist**

- [ ] I’m willing to open a PR for this (see [CONTRIBUTING.md](https://github.com/drwpow/openapi-typescript/blob/main/CONTRIBUTING.md))
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/unsupported-schema-syntax.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
name: Unsupported schema syntax
about: Part of the OpenAPI spec isn’t generating as expected (or at all)
title: ''
labels: bug
assignees: ''

---

**Description**

_A brief description of the issue. _

_[Link to the OpenAPI version & spec description](#)_

**OpenAPI**

```yaml
# Your OpenAPI schema (can be a stub)
```

**Generated TS**

```ts
// What’s generated in the current version (or put “nothing” if it’s skipped)
```

**Expected TS*

```ts
// What you’d like to see generated
```

**Checklist**

- [ ] My OpenAPI schema passes a validator
- [ ] I’m willing to open a PR for this (see [CONTRIBUTING.md](https://github.com/drwpow/openapi-typescript/blob/main/CONTRIBUTING.md))