From c7d4430b2a371d0812c13f5597ed9fbcbb9588af Mon Sep 17 00:00:00 2001 From: Byron Ruth Date: Tue, 17 Oct 2023 12:31:04 -0400 Subject: [PATCH] Simplify and relax issue forms further (#157) Signed-off-by: Byron Ruth --- .github/ISSUE_TEMPLATE/defect.yml | 40 +++++++++++++++++------------ .github/ISSUE_TEMPLATE/proposal.yml | 26 ++++++++----------- 2 files changed, 33 insertions(+), 33 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/defect.yml b/.github/ISSUE_TEMPLATE/defect.yml index 99b4800a8..4816b811a 100644 --- a/.github/ISSUE_TEMPLATE/defect.yml +++ b/.github/ISSUE_TEMPLATE/defect.yml @@ -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 + required: false diff --git a/.github/ISSUE_TEMPLATE/proposal.yml b/.github/ISSUE_TEMPLATE/proposal.yml index d7da0ca49..7158383b8 100644 --- a/.github/ISSUE_TEMPLATE/proposal.yml +++ b/.github/ISSUE_TEMPLATE/proposal.yml @@ -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