Skip to content

Commit c89e81a

Browse files
Ryun1rphair
andauthoredSep 7, 2023
CIP-0001 | Add Versioning + other small edits (cardano-foundation#563)
* Add versioning + other small details * re-introducing 4877c07 - clobbered in force push * grammar correction * Added details to CIP template to match CIP-01 * removed folder name options --------- Co-authored-by: Robert Phair <[email protected]>
1 parent 8018dc4 commit c89e81a

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed
 

‎.github/CIP-TEMPLATE.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ License: CC-BY-4.0
3232
<!-- A clear explanation that introduces the reason for a proposal, its use cases and stakeholders. If the CIP changes an established design then it must outline design issues that motivate a rework. For complex proposals, authors must write a Cardano Problem Statement (CPS) as defined in CIP-9999 and link to it as the `Motivation`. -->
3333

3434
## Specification
35-
<!-- The technical specification should describe the proposed improvement in sufficient technical detail. In particular, it should provide enough information that an implementation can be performed solely on the basis of the design in the CIP. This is necessary to facilitate multiple, interoperable implementations. -->
35+
<!-- The technical specification should describe the proposed improvement in sufficient technical detail. In particular, it should provide enough information that an implementation can be performed solely on the basis of the design in the CIP. This is necessary to facilitate multiple, interoperable implementations. This must include how the CIP should be versioned. If a proposal defines structure of on-chain data it must include a CDDL schema in it's specification.-->
3636

3737
## Rationale: how does this CIP achieve its goals?
3838
<!-- The rationale fleshes out the specification by describing what motivated the design and what led to particular design decisions. It should describe alternate designs considered and related work. The rationale should provide evidence of consensus within the community and discuss significant objections or concerns raised during the discussion.

‎CIP-0001/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ Name | Description
7878
Preamble | Headers containing metadata about the CIP ([see below](#header-preamble)).
7979
Abstract | A short (\~200 word) description of the proposed solution and the technical issue being addressed.
8080
Motivation: why is this CIP necessary? | A clear explanation that introduces a proposal's purpose, use cases, and stakeholders. If the CIP changes an established design, it must outline design issues that motivate a rework. For complex proposals, authors must write a [Cardano Problem Statement (CPS) as defined in CIP-9999][CPS] and link to it as the `Motivation`.
81-
Specification | The technical specification should describe the proposed improvement in sufficient technical detail. In particular, it should provide enough information that an implementation can be performed solely based on the design outlined in the CIP. A complete and unambiguous design is necessary to facilitate multiple interoperable implementations.
81+
Specification | The technical specification should describe the proposed improvement in sufficient technical detail. In particular, it should provide enough information that an implementation can be performed solely based on the design outlined in the CIP. A complete and unambiguous design is necessary to facilitate multiple interoperable implementations. <br/><br/>This must include how the CIP should be versioned. Stipulating that the proposal must be superseded by another is valid versioning. Adequate description must be given to allow versioned alterations to be added without author oversight. <br/><br/> If a proposal defines structure of on-chain data it must include a CDDL schema.
8282
Rationale: how does this CIP achieve its goals? | The rationale fleshes out the specification by describing what motivated the design and what led to particular design decisions. It should describe alternate designs considered and related work. The rationale should provide evidence of consensus within the community and discuss significant objections or concerns raised during the discussion. <br/><br/>It must also explain how the proposal affects the backward compatibility of existing solutions when applicable. If the proposal responds to a [CPS][], the 'Rationale' section should explain how it addresses the CPS and answer any questions that the CPS poses for potential solutions.
8383
Path to Active | Organised in two sub-sections (see [Path to Active](#path-to-active) for detail):<br/><h5>Acceptance Criteria</h5>Describes what are the acceptance criteria whereby a proposal becomes _'Active'_.<br/><h5>Implementation Plan</h5>Either a plan to meet those criteria or `N/A` if not applicable.
8484
Copyright | The CIP must be explicitly licensed under acceptable copyright terms ([see below](#licensing)).
@@ -127,7 +127,7 @@ License: CC-BY-4.0
127127
128128
##### Repository Organization
129129

130-
A CIP must be stored in a specific folder named after its number (4-digit, left-padded with `0`) and in a file called `README.md`. Before a number is assigned, use `????` as a placeholder number (thus naming new folders as `CIP-????`). After a number has been assigned, rename the folder.
130+
A CIP must be stored in a specific folder named after its number (4-digit, left-padded with `0`) and in a file called `README.md`. Before a number is assigned, a placeholder folder name should be used (e.g. `CIP-my-new-feature`). After a number has been assigned, rename the folder.
131131

132132
Additional supporting files (such as diagrams, binary specifications, dialect grammars, JSON schemas etc.) may be added to the CIP's folder under freely chosen names.
133133

0 commit comments

Comments
 (0)
Please sign in to comment.