You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@couchdb.apache.org by wo...@apache.org on 2019/01/23 19:32:11 UTC
[couchdb] branch master updated: Shift to new GH multi-template
issue workflow (#1872)
This is an automated email from the ASF dual-hosted git repository.
wohali pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/couchdb.git
The following commit(s) were added to refs/heads/master by this push:
new 30d0f7b Shift to new GH multi-template issue workflow (#1872)
30d0f7b is described below
commit 30d0f7b20c51895a6499e79968d1c680e309cf20
Author: Joan Touzet <wo...@users.noreply.github.com>
AuthorDate: Wed Jan 23 14:32:06 2019 -0500
Shift to new GH multi-template issue workflow (#1872)
---
.github/ISSUE_TEMPLATE.md | 32 --------------
.github/ISSUE_TEMPLATE/bug_report.md | 36 ++++++++++++++++
.github/ISSUE_TEMPLATE/enhancement.md | 27 ++++++++++++
.github/ISSUE_TEMPLATE/rfc.md | 81 +++++++++++++++++++++++++++++++++++
4 files changed, 144 insertions(+), 32 deletions(-)
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
deleted file mode 100644
index be4f816..0000000
--- a/.github/ISSUE_TEMPLATE.md
+++ /dev/null
@@ -1,32 +0,0 @@
-<!--- Provide a general summary of the issue in the Title above -->
-
-## Expected Behavior
-<!--- If you're describing a bug, tell us what should happen -->
-<!--- If you're suggesting a change/improvement, tell us how it should work -->
-
-## Current Behavior
-<!--- If describing a bug, tell us what happens instead of the expected behavior -->
-<!--- If suggesting a change/improvement, explain the difference from current behavior -->
-
-## Possible Solution
-<!--- Not obligatory, but suggest a fix/reason for the bug, -->
-<!--- or ideas how to implement the addition or change -->
-
-## Steps to Reproduce (for bugs)
-<!--- Provide a link to a live example, or an unambiguous set of steps to -->
-<!--- reproduce this bug. Include code to reproduce, if relevant -->
-1.
-2.
-3.
-4.
-
-## Context
-<!--- How has this issue affected you? What are you trying to accomplish? -->
-<!--- Providing context helps us come up with a solution that is most useful in the real world -->
-
-## Your Environment
-<!--- Include as many relevant details about the environment you experienced the bug in -->
-* Version used:
-* Browser Name and version:
-* Operating System and version (desktop or mobile):
-* Link to your project:
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
new file mode 100644
index 0000000..6c43a13
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,36 @@
+---
+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 prbolem here. )
diff --git a/.github/ISSUE_TEMPLATE/enhancement.md b/.github/ISSUE_TEMPLATE/enhancement.md
new file mode 100644
index 0000000..ca92725
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/enhancement.md
@@ -0,0 +1,27 @@
+---
+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/rfc.md b/.github/ISSUE_TEMPLATE/rfc.md
new file mode 100644
index 0000000..e1790c0
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/rfc.md
@@ -0,0 +1,81 @@
+---
+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. )
+
+## Modules affected
+
+[NOTE]: # ( List the OTP 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 defintions )
+[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. )
+
+# 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? )