From 17e6090d206603b50b26d79932d84d91c22f8e1c Mon Sep 17 00:00:00 2001 From: Byron Ruth Date: Mon, 21 Aug 2023 16:07:46 -0400 Subject: [PATCH 1/2] Add issue forms Signed-off-by: Byron Ruth --- .github/ISSUE_TEMPLATE/config.yml | 9 ++++--- .github/ISSUE_TEMPLATE/defect.yml | 41 +++++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/proposal.yml | 34 ++++++++++++++++++++++++ 3 files changed, 81 insertions(+), 3 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/defect.yml create mode 100644 .github/ISSUE_TEMPLATE/proposal.yml diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 989f7213a..ad105397d 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,5 +1,8 @@ -blank_issues_enabled: true +blank_issues_enabled: false contact_links: - - name: NATS Slack + - name: Discussion + url: https://github.com/nats-io/nats-server/discussions + about: Ideal for ideas, feedback, or longer form questions. + - name: Chat url: https://slack.nats.io - about: Please ask and answer questions in our Slack server here. + about: Ideal for short, one-off questions, general conversation, and meeting other NATS users! diff --git a/.github/ISSUE_TEMPLATE/defect.yml b/.github/ISSUE_TEMPLATE/defect.yml new file mode 100644 index 000000000..99b4800a8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/defect.yml @@ -0,0 +1,41 @@ +--- +name: Defect +description: Report a defect, such as a bug or regression. +labels: + - defect +body: + - type: textarea + id: versions + attributes: + label: What version were you using? + description: Include the server version (`nats-server --version`) and any client versions when observing the issue. + validations: + required: true + - type: textarea + id: environment + attributes: + label: What environment was the server running in? + description: This pertains to the operating system, CPU architecture, and/or Docker image that was used. + validations: + required: true + - type: textarea + id: steps + attributes: + label: Is this defect reproducible? + description: Provide best-effort steps to showcase the defect. + validations: + required: true + - type: textarea + id: expected + attributes: + label: Given the capability you are leveraging, describe your expectation? + description: This may be the expected behavior or performance characteristics. + validations: + required: true + - type: textarea + id: actual + attributes: + label: Given the expectation, what is the defect you are observing? + description: This may be an unexpected behavior or regression in performance. + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/proposal.yml b/.github/ISSUE_TEMPLATE/proposal.yml new file mode 100644 index 000000000..d7da0ca49 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/proposal.yml @@ -0,0 +1,34 @@ +--- +name: Proposal +description: Propose an enhancement or new feature. +labels: + - proposal +body: + - type: textarea + id: usecase + attributes: + label: What motivated this proposal? + description: Describe the use case justifying this request. + validations: + required: true + - type: textarea + id: change + attributes: + label: What is the proposed change? + description: This could be a behavior change, enhanced API, or a branch new feature. + validations: + required: true + - type: textarea + id: benefits + attributes: + label: Who benefits from this change? + description: Describe how this not only benefits you. + validations: + required: false + - type: textarea + id: alternates + attributes: + label: What alternatives have you evaluated? + description: This could be using existing features or relying on an external dependency. + validations: + required: false From 0f1fc1dd6ba5feb6c76d711fd7bce147cacfaa88 Mon Sep 17 00:00:00 2001 From: Byron Ruth Date: Tue, 22 Aug 2023 05:54:29 -0400 Subject: [PATCH 2/2] Fix link and remove existing files [ci skip] Signed-off-by: Byron Ruth --- .github/ISSUE_TEMPLATE/blank_issue.md | 4 ---- .github/ISSUE_TEMPLATE/config.yml | 2 +- .github/ISSUE_TEMPLATE/defect.md | 23 ----------------------- .github/ISSUE_TEMPLATE/feature_request.md | 16 ---------------- 4 files changed, 1 insertion(+), 44 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/blank_issue.md delete mode 100644 .github/ISSUE_TEMPLATE/defect.md delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/blank_issue.md b/.github/ISSUE_TEMPLATE/blank_issue.md deleted file mode 100644 index 38ba94634..000000000 --- a/.github/ISSUE_TEMPLATE/blank_issue.md +++ /dev/null @@ -1,4 +0,0 @@ ---- -name: Blank Issue -about: Create an issue with a blank template. ---- diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index ad105397d..950257545 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,7 +1,7 @@ blank_issues_enabled: false contact_links: - name: Discussion - url: https://github.com/nats-io/nats-server/discussions + url: https://github.com/nats-io/nats.go/discussions about: Ideal for ideas, feedback, or longer form questions. - name: Chat url: https://slack.nats.io diff --git a/.github/ISSUE_TEMPLATE/defect.md b/.github/ISSUE_TEMPLATE/defect.md deleted file mode 100644 index be4ead965..000000000 --- a/.github/ISSUE_TEMPLATE/defect.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -name: Bug Report -about: Report a bug found in the NATS Go library -labels: bug ---- - -## Defect - -Make sure that these boxes are checked before submitting your issue -- thank you! - - - [ ] Included nats.go version - - [ ] Included a [Minimal, Complete, and Verifiable example] (https://stackoverflow.com/help/mcve) - -#### Versions of `nats.go` and the `nats-server` if one was involved: - -#### OS/Container environment: - -#### Steps or code to reproduce the issue: - -#### Expected result: - -#### Actual result: - diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 10de66e31..000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -name: Feature Request -about: Request a feature for the NATS Go library -labels: feature ---- - -## Feature Request - -#### Use Case: - -#### Proposed Change: - -#### Who Benefits From The Change(s)? - -#### Alternative Approaches -