Standardize issue forms (#4408)

This commit is contained in:
Waldemar Quevedo
2023-08-21 06:16:38 -07:00
committed by GitHub
6 changed files with 81 additions and 46 deletions

View File

@@ -1,4 +0,0 @@
---
name: Blank Issue
about: Create an issue with a blank template.
---

View File

@@ -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!

View File

@@ -1,23 +0,0 @@
---
name: Defect Report
about: Report a bug found in the NATS Server
labels: 🐞 bug
---
## Defect
Make sure that these boxes are checked before submitting your issue -- thank you!
- [ ] Included `nats-server -DV` output
- [ ] Included a [Minimal, Complete, and Verifiable example] (https://stackoverflow.com/help/mcve)
#### Versions of `nats-server` and affected client libraries used:
#### OS/Container environment:
#### Steps or code to reproduce the issue:
#### Expected result:
#### Actual result:

41
.github/ISSUE_TEMPLATE/defect.yml vendored Normal file
View File

@@ -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

View File

@@ -1,16 +0,0 @@
---
name: Feature Request
about: Request a feature for the NATS Server
labels: 🎉 enhancement
---
## Feature Request
#### Use Case:
#### Proposed Change:
#### Who Benefits From The Change(s)?
#### Alternative Approaches

34
.github/ISSUE_TEMPLATE/proposal.yml vendored Normal file
View File

@@ -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