This is an automated email from the ASF dual-hosted git repository. rnewson pushed a commit to branch github-issue-forms in repository https://gitbox.apache.org/repos/asf/couchdb.git
commit 1378f37aab6b8e4e88aecf5945613fa0e9bfec88 Author: Robert Newson <[email protected]> AuthorDate: Fri Dec 5 13:51:41 2025 +0000 try again --- .github/ISSUE_TEMPLATE/bug_report.md | 36 ------------- .github/ISSUE_TEMPLATE/bug_report.yml | 60 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 1 + .github/ISSUE_TEMPLATE/enhancement.md | 27 ---------- .github/ISSUE_TEMPLATE/enhancement.yml | 22 ++++++++ .github/ISSUE_TEMPLATE/rfc.md | 85 ------------------------------- .github/ISSUE_TEMPLATE/rfc.yml | 93 ++++++++++++++++++++++++++++++++++ 7 files changed, 176 insertions(+), 148 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 360d4fa62..000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -name: Bug report -about: Describe a scenario in which CouchDB behaves unexpectedly -title: '' -labels: bug, needs-triage -assignees: '' - ---- - -[NOTE]: # ( ^^ Provide a general summary of the issue in the title above. ^^ ) - -## Description - -[NOTE]: # ( Describe the problem you're encountering. ) -[TIP]: # ( Do NOT give us access or passwords to your actual CouchDB! ) - -## Steps to Reproduce - -[NOTE]: # ( Include commands to reproduce, if possible. curl is preferred. ) - -## Expected Behaviour - -[NOTE]: # ( Tell us what you expected to happen. ) - -## Your Environment - -[TIP]: # ( Include as many relevant details about your environment as possible. ) -[TIP]: # ( You can paste the output of curl http://YOUR-COUCHDB:5984/ here. ) - -* CouchDB version used: -* Browser name and version: -* Operating system and version: - -## Additional Context - -[TIP]: # ( Add any other context about the problem here. ) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 000000000..ca64ae855 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,60 @@ +name: Bug report +description: Describe a scenario in which CouchDB behaves unexpectedly +title: "[Bug]: " +labels: ["bug", "triage"] +body: + - type: dropdown + id: version + attributes: + label: Version + description: What version of our software are you running? + options: + - unknown + - 3.0.0 + - 3.0.1 + - 3.1.0 + - 3.1.1 + - 3.1.2 + - 3.2.0 + - 3.2.1 + - 3.2.2 + - 3.2.3 + - 3.3.0 + - 3.3.1 + - 3.3.2 + - 3.3.3 + - 3.4.0 + - 3.4.1 + - 3.4.2 + - 3.4.3 + - 3.5.0 + - 3.5.1 + default: 0 + - type: textarea + id: summary + attributes: + label: Describe the problem you're encountering + validations: + required: true + - type: textarea + id: expected-behaviour + attributes: + label: Expected Behaviour + description: Tell us what you expected to happen + validations: + required: true + - type: textarea + id: repro-steps + attributes: + label: Steps to Reproduce + description: Include commands to reproduce, if possible. curl is preferred + - type: textarea + id: environment + attributes: + label: Your Environment + description: Include as many relevant details about your environment as possible + - type: textarea + id: additional-context + attributes: + label: Additional Context + description: Add any other context about the problem here diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..3ba13e0ce --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: false diff --git a/.github/ISSUE_TEMPLATE/enhancement.md b/.github/ISSUE_TEMPLATE/enhancement.md deleted file mode 100644 index ca92725a6..000000000 --- a/.github/ISSUE_TEMPLATE/enhancement.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -name: Enhancement request -about: Suggest an idea for a future version of CouchDB -title: '' -labels: enhancement, needs-triage -assignees: '' - ---- - -[NOTE]: # ( ^^ Provide a general summary of the request in the title above. ^^ ) - -## Summary - -[NOTE]: # ( Provide a brief overview of what the new feature is all about. ) - -## Desired Behaviour - -[NOTE]: # ( Tell us how the new feature should work. Be specific. ) -[TIP]: # ( Do NOT give us access or passwords to your actual CouchDB! ) - -## Possible Solution - -[NOTE]: # ( Not required. Suggest how to implement the addition or change. ) - -## Additional context - -[TIP]: # ( Why does this feature matter to you? What unique circumstances do you have? ) diff --git a/.github/ISSUE_TEMPLATE/enhancement.yml b/.github/ISSUE_TEMPLATE/enhancement.yml new file mode 100644 index 000000000..7e24c4256 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/enhancement.yml @@ -0,0 +1,22 @@ +name: Enhancement request +description: Suggest an idea for a future version of CouchDB +title: '[ENHANCEMENT]: ' +labels: ["enhancement", "needs-triage"] +body: + - type: textarea + id: summary + attributes: + label: Provide a brief overview of what the new feature is all about + - type: textarea + id: desired-behaviour + attributes: + label: Tell us how the new feature should work. Be specific + - type: textarea + id: possible-solution + attributes: + label: Not required. Suggest how to implement the addition or change + - type: textarea + id: additional-context + attributes: + label: Additional Context + description: Why does this feature matter to you? What unique circumstances do you have? diff --git a/.github/ISSUE_TEMPLATE/rfc.md b/.github/ISSUE_TEMPLATE/rfc.md deleted file mode 100644 index a966bd9f8..000000000 --- a/.github/ISSUE_TEMPLATE/rfc.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -name: Formal RFC -about: Submit a formal Request For Comments for consideration by the team. -title: '' -labels: rfc, discussion -assignees: '' - ---- - -[NOTE]: # ( ^^ Provide a general summary of the RFC in the title above. ^^ ) - -# Introduction - -## Abstract - -[NOTE]: # ( Provide a 1-to-3 paragraph overview of the requested change. ) -[NOTE]: # ( Describe what problem you are solving, and the general approach. ) - -## Requirements Language - -[NOTE]: # ( Do not alter the section below. Follow its instructions. ) - -The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", -"SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this -document are to be interpreted as described in -[RFC 2119](https://www.rfc-editor.org/rfc/rfc2119.txt). - -## Terminology - -[TIP]: # ( Provide a list of any unique terms or acronyms, and their definitions here.) - ---- - -# Detailed Description - -[NOTE]: # ( Describe the solution being proposed in greater detail. ) -[NOTE]: # ( Assume your audience has knowledge of, but not necessarily familiarity ) -[NOTE]: # ( with, the CouchDB internals. Provide enough context so that the reader ) -[NOTE]: # ( can make an informed decision about the proposal. ) - -[TIP]: # ( Artwork may be attached to the submission and linked as necessary. ) -[TIP]: # ( ASCII artwork can also be included in code blocks, if desired. ) - -# Advantages and Disadvantages - -[NOTE]: # ( Briefly, list the benefits and drawbacks that would be realized should ) -[NOTE]: # ( the proposal be accepted for inclusion into Apache CouchDB. ) - -# Key Changes - -[TIP]: # ( If the changes will affect how a user interacts with CouchDB, explain. ) - -## Applications and Modules affected - -[NOTE]: # ( List the OTP applications or functional modules in CouchDB affected by the proposal. ) - -## HTTP API additions - -[NOTE]: # ( Provide *exact* detail on each new API endpoint, including: ) -[NOTE]: # ( HTTP methods [HEAD, GET, PUT, POST, DELETE, etc.] ) -[NOTE]: # ( Synopsis of functionality ) -[NOTE]: # ( Headers and parameters accepted ) -[NOTE]: # ( JSON in [if a PUT or POST type] ) -[NOTE]: # ( JSON out ) -[NOTE]: # ( Valid status codes and their definitions ) -[NOTE]: # ( A proposed Request and Response block ) - -## HTTP API deprecations - -[NOTE]: # ( Provide *exact* detail on the API endpoints to be deprecated. ) -[NOTE]: # ( If these endpoints are replaced by new endpoints, list those as well. ) -[NOTE]: # ( State the proposed version in which the deprecation and removal will occur. ) - -# Security Considerations - -[NOTE]: # ( Include any impact to the security of CouchDB here. ) - -# References - -[TIP]: # ( Include any references to CouchDB documentation, mailing list discussion, ) -[TIP]: # ( external standards or other links here. ) - -# Acknowledgements - -[TIP]: # ( Who helped you write this RFC? ) diff --git a/.github/ISSUE_TEMPLATE/rfc.yml b/.github/ISSUE_TEMPLATE/rfc.yml new file mode 100644 index 000000000..64359e136 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/rfc.yml @@ -0,0 +1,93 @@ +name: Formal RFC +description: Submit a formal Request For Comments for consideration by the team. +title: '[RFC]: ' +labels: ["rfc", "discussion"] +body: + - type: markdown + attributes: + value: | + ## Requirements Language + + The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", + "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this + document are to be interpreted as described in + [RFC 2119](https://www.rfc-editor.org/rfc/rfc2119.txt). + - type: textarea + id: abstract + attributes: + label: Provide a 1-to-3 paragraph overview of the requested change. + - type: textarea + id: terminology + attributes: + label: Terminology + - type: textarea + id: detailed-description + attributes: + label: Detailed Description + description: | + Describe the solution being proposed in greater detail. Assume your + audience has knowledge of, but not necessarily familiarity with, the + CouchDB internals. Provide enough context so that the reader can make an + informed decision about the proposal. + + Artwork may be attached to the submission and linked as necessary. + ASCII artwork can also be included in code blocks, if desired. + - type: textarea + id: advantages-and-disadvantages + attributes: + label: Advantages and Disadvantages + description: | + Briefly, list the benefits and drawbacks that would be realized should + the proposal be accepted for inclusion into Apache CouchDB. + - type: textarea + id: key-changes + attributes: + label: Key Changes + description: If the changes will affect how a user interacts with CouchDB, explain + - type: textarea + id: applications-and-modules-affected + attributes: + label: Applications and Modules affected + description: List the OTP applications or functional modules in CouchDB affected by the proposal + - type: textarea + id: http-api-additions + attributes: + label: HTTP API additions + description: | + Provide *exact* detail on each new API endpoint, including: + HTTP methods [HEAD, GET, PUT, POST, DELETE, etc.] + Synopsis of functionality + Headers and parameters accepted + JSON in [if a PUT or POST type] + JSON out + Valid status codes and their definitions + A proposed Request and Response block + placeholder: None + - type: textarea + id: http-api-deprecations + attributes: + label: HTTP API deprecations + description: | + Provide *exact* detail on the API endpoints to be deprecated. + If these endpoints are replaced by new endpoints, list those as well. + State the proposed version in which the deprecation and removal will occur. + placeholder: None + - type: textarea + id: security-considerations + attributes: + label: Security Considerations + description: Include any impact to the security of CouchDB here + placeholder: None + - type: textarea + id: references + attributes: + label: References + description: | + Include any references to CouchDB documentation, mailing list discussion, + external standards or other links here. + placeholder: None + - type: textarea + id: acknowledgements + attributes: + label: Acknowledgements + placeholder: None
