Skip to content

Commit 1a519a7

Browse files
authored
CIP-0001 | Titles for CIPs with common purpose (cardano-foundation#594)
* draft language for common CIP element name + delimiter * changed pipe char in table to use code tags + entity code * reverting | to - for common subject delimiter * minor change to make language more objective
1 parent fbfdea6 commit 1a519a7

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

CIP-0001/README.md

+9-1
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ The CIP process does not _by itself_ offer any form of governance. For example,
5454
- [Process](#process)
5555
- [1. Early Stage](#1-early-stages)
5656
- [1.a. Authors open a pull request](#1a-authors-open-a-pull-request)
57+
- [Naming CIPs with similar subjects](#naming-cips-with-similar-subjects)
5758
- [1.b. Authors seek feedback](#1b-authors-seek-feedback)
5859
- [2. Editors' role](#2-editors-role)
5960
- [2.a. Triage in bi-weekly meetings](#2a-triage-in-bi-weekly-meetings)
@@ -92,7 +93,7 @@ Each CIP must begin with a YAML key:value style header preamble (also known as _
9293
Field | Description
9394
--- | ---
9495
`CIP` | The CIP number (without leading 0), or "\?" before being assigned
95-
`Title` | A succinct and descriptive title
96+
`Title` | A succinct and descriptive title. If necessary, use a `-` delimiter to begin with an applicable classification (see [Naming CIPs with similar subjects](#naming-cips-with-similar-subjects)).
9697
`Status` | Proposed \| Active \| Inactive (.._reason_..)
9798
`Category` | One of the registered [categories](#categories) covering one area of the ecosystem.
9899
`Authors` | A list of authors' real names and email addresses (e.g. John Doe <[email protected]>)
@@ -284,6 +285,13 @@ Proposals must be submitted to the [cardano-foundation/CIPs][Repository] reposit
284285
285286
> **Note** Proposals addressing a specific CPS should also be listed in the corresponding CPS header, in _'Proposed Solutions'_, to keep track of ongoing work.
286287
288+
###### Naming CIPs with similar subjects
289+
290+
When a CIP title *and* subject matter share a common element, begin the CIP title with that common element and end it with the specifc portion, delimited with the `-` character. Example (CIP-0095):
291+
292+
> *Web-Wallet Bridge **-** Governance*
293+
294+
CIP editors will help determine these common elements and, whenever necessary, rename both CIP document titles and PR titles accordingly. The objective is to provide commonly recognisable names for similar developments (e.g. multiple extensions to another CIP or scheme).
287295
288296
##### 1.b. Authors seek feedback
289297

0 commit comments

Comments
 (0)