From 172258f5361cf4896a2365b2ed56fa799285bedd Mon Sep 17 00:00:00 2001 From: Drew Powers <1369770+drwpow@users.noreply.github.com> Date: Sun, 30 Oct 2022 09:00:22 -0600 Subject: [PATCH 1/3] Update issue templates --- .github/ISSUE_TEMPLATE/bug-report.md | 34 +++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 ++++++++++ .../unsupported-schema-syntax.md | 37 +++++++++++++++++++ 3 files changed, 91 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/unsupported-schema-syntax.md diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md new file mode 100644 index 000000000..11cafc407 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -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)) diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 000000000..9e75a3856 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -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)) diff --git a/.github/ISSUE_TEMPLATE/unsupported-schema-syntax.md b/.github/ISSUE_TEMPLATE/unsupported-schema-syntax.md new file mode 100644 index 000000000..cd91416d0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/unsupported-schema-syntax.md @@ -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)) From 07d3d808b85f0af5b5cb1625f5b3ae93a1eb374b Mon Sep 17 00:00:00 2001 From: Drew Powers Date: Sun, 30 Oct 2022 09:00:59 -0600 Subject: [PATCH 2/3] Remove unused templates. --- .github/ISSUE_TEMPLATE/bug.md | 10 ---------- .github/ISSUE_TEMPLATE/feature.md | 10 ---------- 2 files changed, 20 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug.md delete mode 100644 .github/ISSUE_TEMPLATE/feature.md diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.md deleted file mode 100644 index f78be594f..000000000 --- a/.github/ISSUE_TEMPLATE/bug.md +++ /dev/null @@ -1,10 +0,0 @@ -# 🦟 Bug Report - -## Error description - - - - -## Expected output - - diff --git a/.github/ISSUE_TEMPLATE/feature.md b/.github/ISSUE_TEMPLATE/feature.md deleted file mode 100644 index 1d49e9f93..000000000 --- a/.github/ISSUE_TEMPLATE/feature.md +++ /dev/null @@ -1,10 +0,0 @@ -# ✨ Feature request - -## OpenAPI Schema - - - -## Proposal - - - From 1e70cf5ea24a00d31465352cb2c11440b35a9183 Mon Sep 17 00:00:00 2001 From: Drew Powers Date: Sun, 30 Oct 2022 09:02:30 -0600 Subject: [PATCH 3/3] Formatting --- .github/ISSUE_TEMPLATE/bug-report.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md index 11cafc407..2f075cd11 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -15,11 +15,11 @@ _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.` | +| Name | Version | +|:---------------------|:-----------------------------| +| `openapi-typescript` | `x.x.x` | +| Node.js | `x.x.x` | +| OS + version | `macOS 13, Windows 11, etc.` | **Reproduction**