|
| 1 | +name: Formal RFC |
| 2 | +description: Submit a formal Request For Comments for consideration by the team. |
| 3 | +title: '[RFC]: ' |
| 4 | +labels: ["rfc", "discussion"] |
| 5 | +body: |
| 6 | + - type: markdown |
| 7 | + attributes: |
| 8 | + value: | |
| 9 | + ## Requirements Language |
| 10 | +
|
| 11 | + The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", |
| 12 | + "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this |
| 13 | + document are to be interpreted as described in |
| 14 | + [RFC 2119](https://www.rfc-editor.org/rfc/rfc2119.txt). |
| 15 | + - type: textarea |
| 16 | + id: abstract |
| 17 | + attributes: |
| 18 | + label: Provide a 1-to-3 paragraph overview of the requested change. |
| 19 | + - type: textarea |
| 20 | + id: terminology |
| 21 | + attributes: |
| 22 | + label: Terminology |
| 23 | + - type: textarea |
| 24 | + id: detailed-description |
| 25 | + attributes: |
| 26 | + label: Detailed Description |
| 27 | + description: | |
| 28 | + Describe the solution being proposed in greater detail. Assume your |
| 29 | + audience has knowledge of, but not necessarily familiarity with, the |
| 30 | + CouchDB internals. Provide enough context so that the reader can make an |
| 31 | + informed decision about the proposal. |
| 32 | +
|
| 33 | + Artwork may be attached to the submission and linked as necessary. |
| 34 | + ASCII artwork can also be included in code blocks, if desired. |
| 35 | + - type: textarea |
| 36 | + id: advantages-and-disadvantages |
| 37 | + attributes: |
| 38 | + label: Advantages and Disadvantages |
| 39 | + description: | |
| 40 | + Briefly, list the benefits and drawbacks that would be realized should |
| 41 | + the proposal be accepted for inclusion into Apache CouchDB. |
| 42 | + - type: textarea |
| 43 | + id: key-changes |
| 44 | + attributes: |
| 45 | + label: Key Changes |
| 46 | + description: If the changes will affect how a user interacts with CouchDB, explain |
| 47 | + - type: textarea |
| 48 | + id: applications-and-modules-affected |
| 49 | + attributes: |
| 50 | + label: Applications and Modules affected |
| 51 | + description: List the OTP applications or functional modules in CouchDB affected by the proposal |
| 52 | + - type: textarea |
| 53 | + id: http-api-additions |
| 54 | + attributes: |
| 55 | + label: HTTP API additions |
| 56 | + description: | |
| 57 | + Provide *exact* detail on each new API endpoint, including: |
| 58 | + HTTP methods [HEAD, GET, PUT, POST, DELETE, etc.] |
| 59 | + Synopsis of functionality |
| 60 | + Headers and parameters accepted |
| 61 | + JSON in [if a PUT or POST type] |
| 62 | + JSON out |
| 63 | + Valid status codes and their definitions |
| 64 | + A proposed Request and Response block |
| 65 | + placeholder: None |
| 66 | + - type: textarea |
| 67 | + id: http-api-deprecations |
| 68 | + attributes: |
| 69 | + label: HTTP API deprecations |
| 70 | + description: | |
| 71 | + Provide *exact* detail on the API endpoints to be deprecated. |
| 72 | + If these endpoints are replaced by new endpoints, list those as well. |
| 73 | + State the proposed version in which the deprecation and removal will occur. |
| 74 | + placeholder: None |
| 75 | + - type: textarea |
| 76 | + id: security-considerations |
| 77 | + attributes: |
| 78 | + label: Security Considerations |
| 79 | + description: Include any impact to the security of CouchDB here |
| 80 | + placeholder: None |
| 81 | + - type: textarea |
| 82 | + id: references |
| 83 | + attributes: |
| 84 | + label: References |
| 85 | + description: | |
| 86 | + Include any references to CouchDB documentation, mailing list discussion, |
| 87 | + external standards or other links here. |
| 88 | + placeholder: None |
| 89 | + - type: textarea |
| 90 | + id: acknowledgements |
| 91 | + attributes: |
| 92 | + label: Acknowledgements |
| 93 | + placeholder: None |
0 commit comments