Skip to content

Commit

Permalink
Simplify issue forms (#966)
Browse files Browse the repository at this point in the history
  • Loading branch information
bruth authored Sep 6, 2023
1 parent 15cb79d commit 2c67241
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 32 deletions.
38 changes: 22 additions & 16 deletions .github/ISSUE_TEMPLATE/defect.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,37 +5,43 @@ labels:
- defect
body:
- type: textarea
id: versions
id: observed
attributes:
label: What version were you using?
description: Include the server version (`nats-server --version`) and any client versions when observing the issue.
label: Observed behavior
description: Describe the unexpected behavior or performance regression you are observing.
validations:
required: true
- type: textarea
id: environment
id: expected
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.
label: Expected behavior
description: Describe the expected behavior or performance characteristics.
validations:
required: true
- type: textarea
id: steps
id: versions
attributes:
label: Is this defect reproducible?
description: Provide best-effort steps to showcase the defect.
label: Server and client version
description: |-
Provide the versions you were using when the detect was observed.
For the server, use `nats-server --version`, check the startup log output, or the image tag pulled from Docker.
For the CLI client, use `nats --version`.
For language-specific clients, check the version downloaded by the language dependency manager.
validations:
required: true
- type: textarea
id: expected
id: environment
attributes:
label: Given the capability you are leveraging, describe your expectation?
description: This may be the expected behavior or performance characteristics.
label: Host environment
description: |-
Specify any relevant details about the host environment the server and/or client was running in,
such as operating system, CPU architecture, container runtime, etc.
validations:
required: true
required: false
- type: textarea
id: actual
id: steps
attributes:
label: Given the expectation, what is the defect you are observing?
description: This may be an unexpected behavior or regression in performance.
label: Steps to reproduce
description: Provide as many concrete steps to reproduce the defect.
validations:
required: true
26 changes: 10 additions & 16 deletions .github/ISSUE_TEMPLATE/proposal.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,31 +4,25 @@ 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.
label: Proposed change
description: This could be a behavior change, enhanced API, or a new feature.
validations:
required: true
- type: textarea
id: benefits
id: usecase
attributes:
label: Who benefits from this change?
description: Describe how this not only benefits you.
label: Use case
description: What is the use case or general motivation for this proposal?
validations:
required: false
required: true
- type: textarea
id: alternates
id: contribute
attributes:
label: What alternatives have you evaluated?
description: This could be using existing features or relying on an external dependency.
label: Contribution
description: |-
Are you intending or interested in contributing code for this proposal if accepted?
validations:
required: false

0 comments on commit 2c67241

Please sign in to comment.