From e2d336d893c7cc7c3a67b584a905f22e8edd296d Mon Sep 17 00:00:00 2001 From: rphair Date: Wed, 9 Oct 2024 13:49:21 +0530 Subject: [PATCH 01/24] fix CIP-0001 title, add rphair co-author, list labels --- CIP-0001/README.md | 13 ++++++++++--- README.md | 2 +- 2 files changed, 11 insertions(+), 4 deletions(-) diff --git a/CIP-0001/README.md b/CIP-0001/README.md index f5661127e0..3ff6a923d5 100644 --- a/CIP-0001/README.md +++ b/CIP-0001/README.md @@ -1,6 +1,6 @@ --- CIP: 1 -Title: Cardano Improvement Proposals +Title: CIP Process Status: Active Category: Meta Authors: @@ -9,6 +9,7 @@ Authors: - Matthias Benkort - Duncan Coutts - Michael Peyton Jones + - Robert Phair Implementors: N/A Discussions: - https://github.com/cardano-foundation/cips/pull/366 @@ -110,7 +111,7 @@ For example: ```yaml --- CIP: 1 -Title: Cardano Improvement Proposals +Title: CIP Process Status: Active Category: Meta Authors: @@ -120,12 +121,18 @@ Authors: - Duncan Coutts Implementors: N/A Discussions: - - https://github.com/cardano-foundation/cips/pulls/1 + - https://github.com/cardano-foundation/cips/pull/366 Created: 2020-03-21 License: CC-BY-4.0 --- ``` +Especially because Markdown link syntax is not supported in the header preamble, labels can be added to clarify list items; e.g.: +``` +Implementors: + - Mlabs: https://mlabs.city +``` + > **Note** A reference template is available in [.github/CIP-TEMPLATE.md][CIP-TEMPLATE.md] ##### Repository Organization diff --git a/README.md b/README.md index 7fd4c6cab8..f8b13cf38d 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ CIP Editors meetings are public, recorded, and [published on Youtube](https://ww | # | Title | Status | | ---- | --- | --- | -| 0001 | [CIP process](./CIP-0001/) | Active | +| 0001 | [CIP Process](./CIP-0001/) | Active | | 0002 | [Coin Selection Algorithms for Cardano](./CIP-0002/) | Active | | 0003 | [Wallet key generation](./CIP-0003/) | Active | | 0004 | [Wallet Checksums](./CIP-0004/) | Proposed | From f138267dab9d59ef6827678b4feb2decbba58f18 Mon Sep 17 00:00:00 2001 From: rphair Date: Wed, 9 Oct 2024 14:15:37 +0530 Subject: [PATCH 02/24] fix anchors + white space, Discord link, add Wiki references --- CIP-0001/README.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/CIP-0001/README.md b/CIP-0001/README.md index 3ff6a923d5..e25081a20d 100644 --- a/CIP-0001/README.md +++ b/CIP-0001/README.md @@ -21,7 +21,7 @@ License: CC-BY-4.0 ## Abstract -A Cardano Improvement Proposal (CIP) is a formalised design document for the Cardano community and the name of the process by which such documents are produced and listed. A CIP provides information or describes a change to the Cardano ecosystem, processes, or environment concisely and in sufficient technical detail. In this CIP, we explain what a CIP is; how the CIP process functions; the role of the CIP Editors; and how users should go about proposing, discussing and structuring a CIP. +A Cardano Improvement Proposal (CIP) is a formalised design document for the Cardano community and the name of the process by which such documents are produced and listed. A CIP provides information or describes a change to the Cardano ecosystem, processes, or environment concisely and in sufficient technical detail. In this CIP, we explain what a CIP is; how the CIP process functions; the role of the CIP Editors; and how users should go about proposing, discussing and structuring a CIP. The Cardano Foundation intends CIPs to be the primary mechanisms for proposing new features, collecting community input on an issue, and documenting design decisions that have gone into Cardano. Plus, because CIPs are text files in a versioned repository, their revision history is the historical record of significant changes affecting Cardano. @@ -35,6 +35,8 @@ CIPs aim to address two challenges mainly: The CIP process does not _by itself_ offer any form of governance. For example, it does not govern the process by which proposed changes to the Cardano protocol are implemented and deployed. Yet, it is a crucial, community-driven component of the governance decision pipeline as it helps to collect thoughts and proposals in an organised fashion. Additionally, specific projects may choose to actively engage with the CIP process for some or all changes to their project. +This document outlines the technical structure of the CIP and the technical requirements of the submission and review process. The history, social features and human elements of the CIP process are described the [CIP repository Wiki][Wiki]. + ## Specification ### Table of Contents @@ -324,6 +326,9 @@ As much as possible, commenters/reviewers shall remain unbiased in their judgeme By opening pull requests or posting comments, commenters and authors agree to our [Code of Conduct][CoC]. Any comment infringing this code of conduct shall be removed or altered without prior notice. +> **Note** For acceptability guidelines, including a concise review checklist, see +[CIP Wiki > CIPs for Reviewers & Authors](https://github.com/cardano-foundation/CIPs/wiki/2.-CIPs-for-Reviewers-&-Authors). + #### 2. Editors' role ##### 2.a. Triage in bi-weekly meetings @@ -340,7 +345,7 @@ A dedicated Discord channel may also be created for some long-running discussion #### 3. Merging CIPs in the repository -Once a proposal has reached all requirements for its target status (as explained in [Statuses](#Statuses)) and has been sufficiently and faithfully discussed by community members, it is merged with its target status. +Once a proposal has reached all requirements for its target status (as explained in [Statuses](#statuses)) and has been sufficiently and faithfully discussed by community members, it is merged with its target status. > **Warning** Ideas deemed unsound shall be rejected with justifications or withdrawn by the authors. Similarly, proposals that appear abandoned by their authors shall be rejected until resurrected by their authors or another community member. @@ -358,6 +363,8 @@ Besides, once all of the _'Path to Active'_ requirements have been met, authors ### Editors +For a full, current description of Editor workflow, see [CIP Wiki > CIPs for Editors](https://github.com/cardano-foundation/CIPs/wiki/3.-CIPs-for-Editors). + #### Missions CIP Editors safeguard the CIP process: they form a group enforcing the process described in this document and facilitating conversations between community actors. CIP editors should strive to keep up to date with general technical discussions and Cardano proposals. For each new draft proposal submitted on [cardano-foundation/CIPs][PullRequest] an editor might review it as follows: @@ -473,4 +480,5 @@ This CIP is licensed under [CC-BY-4.0][]. [RFC 822]: https://www.ietf.org/rfc/rfc822.txt [Repository]: https://github.com/cardano-foundation/CIPs/pulls [CoC]: https://github.com/cardano-foundation/CIPs/tree/master/CODE_OF_CONDUCT.md -[Discord]: https://discord.gg/Jy9YM69Ezf +[Discord]: https://discord.gg/J8sGdCuKhs +[Wiki]: https://github.com/cardano-foundation/CIPs/wiki From 53774223d714f3c2f6dba543cc3a126ed2e29300 Mon Sep 17 00:00:00 2001 From: rphair Date: Wed, 9 Oct 2024 14:53:18 +0530 Subject: [PATCH 03/24] Versioning: add link to GitHub commit history, clarified versioning subsections --- CIP-0001/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CIP-0001/README.md b/CIP-0001/README.md index e25081a20d..9ae51b3b04 100644 --- a/CIP-0001/README.md +++ b/CIP-0001/README.md @@ -178,11 +178,11 @@ Field | Description ##### Versioning -CIPs must indicate how the defined Specification is versioned. **Note** this does not apply to the CIP text, for which annotated change logs are automatically generated and available through the GitHub UI as a history of CIP files and directories. +CIPs must indicate how the defined Specification is versioned. **Note** this does not apply to the CIP text, for which annotated change logs are automatically generated and [available through the GitHub UI](https://docs.github.com/en/pull-requests/committing-changes-to-your-project/viewing-and-comparing-commits/differences-between-commit-views) as a history of CIP files and directories. Authors are free to describe any approach to versioning that allows versioned alterations to be added without author oversight. Stipulating that the proposal must be superseded by another is also considered to be valid versioning. -Since this is a functional definition it would typically be in one or more subsections of the Specification, but may also be placed in an optional Versioning section. +A single Versioning scheme can be placed either as a subsection of the Specification section or in an optional Versioning top-level section near the end. If the Specification contains multiple specification subsections, each of these can have a Versioning subsection with it. ##### Licensing From bfdd73a50035be9684eac24814d8dff4bc942d9c Mon Sep 17 00:00:00 2001 From: rphair Date: Wed, 9 Oct 2024 15:47:10 +0530 Subject: [PATCH 04/24] no implementation code; new categories; rewrote Enlistment section --- CIP-0001/README.md | 50 +++++++++++++++++++++++++++------------------- 1 file changed, 30 insertions(+), 20 deletions(-) diff --git a/CIP-0001/README.md b/CIP-0001/README.md index 9ae51b3b04..222bc356f7 100644 --- a/CIP-0001/README.md +++ b/CIP-0001/README.md @@ -251,40 +251,48 @@ This must be subdivided into two sub-sections: CIPs are classified into distinct categories that help organise (and thus, find) them. Categories are meant to be flexible and evolve as new domains emerge. Authors may leave the category as `?` should they not be sure under which category their proposal falls; editors will eventually assign one or reject the proposal altogether should it relate to an area where the CIP process does not apply. -At present, we consider the following list of initial categories: +Submission in these categories can be used whenever appropriate without following any particular submission guidelines: -Category | Description ---- | --- -Meta | Designates meta-CIPs, such as this one, which typically serves another category or group of categories. -Wallets | For standardisation across wallets (hardware, full-node or light). -Tokens | About tokens (fungible or non-fungible) and minting policies in general. -Metadata | For proposals around metadata (on-chain or off-chain). -Tools | A broad category for ecosystem tools not falling into any other category. - -Additionally, projects of the ecosystem may explicitly enlist as new categories. The following section describes how projects can engage with the CIP process. +Category | Description +--- | --- +Meta | Designates meta-CIPs, such as this one, which typically serve another category or group of categories +Wallets | For standardisation across wallets (hardware, full-node or light) +Tokens | About tokens (fungible or non-fungible) and minting policies in general +Metadata | For proposals around metadata (on-chain or off-chain) +Tools | A broad category for ecosystem features not falling into any other category -Registered categories for explicitly enlisted projects are otherwise listed below. +Additionally, representatives of ecosystem categories may explicitly _enlist_ their categories (see next section) to suggest a closer relationship with the CIP process. The following categories are confirmed as enslisted according to CIPs which define that relationship: Category | Description --- | --- Plutus | Changes or additions to Plutus, following the process described in [CIP-0035][] Ledger | For proposals regarding the Cardano ledger, following the process described in [CIP-0084][] -Catalyst | For proposals affecting Project Catalyst or the Jörmungandr project, following the process described in ? + +These tenatively enlisted categories await CIPs to describe any enlistment relationship: + +Category | Description +--- | --- +Catalyst | For proposals affecting Project Catalyst or the Jörmungandr project +Consensus | For proposals affecting implementations of the Cardano Consensus layer and algorithms +Network | Specifications and implementations of Cardano's network protocols and applications #### Project Enlisting -Projects of the Cardano ecosystem that intend to follow the CIP process must explicitly enlist themselves and commit to the following: +Project representatives intending to follow an "enlisted" category above agree to coordinate with related development by sharing efforts to review and validate new proposals. +It should be noted that single organisations can no longer repesent any ecosystem or development category, which makes these enlistment guidelines both decentralised and cooperative, including whenver possible: -- a) allocating time to **review** proposals from actors of the community when solicited by editors (i.e. after one first round of reviews); -- b) defining additional rules and processes whereby external actors can engage with their project as part of the CIP process; -- c) defining boundaries within their project for which the CIP process does apply; -- d) writing CIPs for significant changes introduced in their projects when it applies. +- allocating time to **review** proposals from actors of the community when solicited by editors (i.e. after one first round of reviews); +- defining additional rules and processes whereby external actors can engage with their project as part of the CIP process; +- defining boundaries within their project for which the CIP process does apply; +- establishing points of contact and any designated reviews for a category; +- agreeing upon how proposals move from the state of idea (i.e. CIP) to actual implementation work; +- writing CIPs for significant changes introduced in their projects when it applies. -Enlisting for the CIP process happens by creating a CIP. That CIP must encapsulate the information listed above, as well as any other pieces of information deemed helpful to future authors. Of course, only team members of a target project can author such a proposal. +Any guidelines for this cooperation should be described by a dedicated CIP whenever possible. When such a CIP is posted or supersedes another one, it will be entered into the above table in the Categories section. Participants of enlisted categories should follow the requirements outlined in that CIP and should update such proposals whenever these requirements or relationships change. -> **Warning** A positive review by the maintainers of a project does not constitute a commitment to implement the CIP. It is still the CIP author's responsibility to create an implementation plan and identify implementors. The maintainers of the project may volunteer to participate in implementation, but also may not. Projects' maintainers ultimately define how a proposal can move from the state of idea (i.e. CIP) to actual implementation work. We, however, expect each team that enlists in the CIP process to provide clarity on these elements as they enlist. +> **Warning** A positive review by any enlisted project representative does not constitute a commitment to implement the CIP. It is still the CIP author's responsibility to create an implementation plan and identify implementors. -Editors occasionally invite project maintainers to speak during review meetings and solicit them for ultimate approvals of proposals affecting a project under their authority. Said differently, CIPs that concern (part of) an enlisted project will only be merged after explicit acceptance of the enlisted reviewers. +Editors occasionally invite representatives from enlisted categories to speak during review meetings and solicit them for ultimate approvals of proposals in their area of expertise. > **Note** Optionally, projects may show their enlisting using the following badge on their introductory README: ![](https://github.com/cardano-foundation/CIPs](https://raw.githubusercontent.com/cardano-foundation/CIPs/master/.github/badge.svg) > @@ -300,6 +308,8 @@ Editors occasionally invite project maintainers to speak during review meetings Proposals must be submitted to the [cardano-foundation/CIPs][Repository] repository as a pull request named after the proposal's title. The pull request title **should not** include a CIP number (and use `?` instead as number); the editors will assign one. Discussions may precede a proposal. Early reviews and discussions streamline the process down the line. +> **Note** Pull requests should not include implementation code: any code bases should instead be provided as links to a code repository. + > **Note** Proposals addressing a specific CPS should also be listed in the corresponding CPS header, in _'Proposed Solutions'_, to keep track of ongoing work. ###### Naming CIPs with similar subjects From 1e4aedd869dd806bf414b54598020e4396ec4963 Mon Sep 17 00:00:00 2001 From: rphair Date: Wed, 9 Oct 2024 16:16:18 +0530 Subject: [PATCH 05/24] added Emeritus editors, update CIP-9999 bad HI + impl plan, top README add Wiki + fix comm channels --- CIP-0001/README.md | 6 ++++++ CIP-9999/README.md | 4 +--- README.md | 8 ++++---- 3 files changed, 11 insertions(+), 7 deletions(-) diff --git a/CIP-0001/README.md b/CIP-0001/README.md index 222bc356f7..f55b73b106 100644 --- a/CIP-0001/README.md +++ b/CIP-0001/README.md @@ -412,6 +412,12 @@ Current editors are listed here below: [@Crypto2099]: https://github.com/Crypto2099 [@perturbing]: https://github.com/perturbing +Emeritus editors: +- Frederic Johnson - [@crptmppt](https://github.com/crptmppt) +- Sebastien Guillemot - [@SebastienGllmt](https://github.com/SebastienGllmt) +- Matthias Benkort - [@KtorZ](https://github.com/KtorZ) +- Duncan Coutts - [@dcoutts](https://github.com/dcoutts) + ## Rationale: how does this CIP achieve its goals? ### Key changes from CIP-0001 (version 1) diff --git a/CIP-9999/README.md b/CIP-9999/README.md index 18a8d59505..515cfdc6fb 100644 --- a/CIP-9999/README.md +++ b/CIP-9999/README.md @@ -13,8 +13,6 @@ Created: 2022-10-14 License: CC-BY-4.0 --- -# CIP-9999: Cardano Problem Statements - ## Abstract A Cardano Problem Statement (CPS) is a formalized document for the Cardano ecosystem and the name of the process by which such documents are produced and listed. CPSs are meant to complement CIPs and live side-by-side in the CIP repository as first-class citizens. @@ -187,7 +185,7 @@ This section is meant to _save time_, especially for problem statement authors w ### Implementation Plan -- [ ] Schedule a retrospective in 2-3 months to assess the effectiveness of the process +- [x] Confirm after repeated cycles of CPS submissions, reviews, and merges that the CPS process is both effective and accessible to the community. ## Copyright diff --git a/README.md b/README.md index f8b13cf38d..a790274f26 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,11 @@ ## Cardano Improvement Proposals (CIPs) -A [Cardano Improvement Proposal (CIP)](./CIP-0001) is a formalised design document for the Cardano community and the name of the process by which such documents are produced and listed. A CIP provides information or describes a change to the Cardano ecosystem, processes, or environment concisely and in sufficient technical detail. In this CIP, we explain what a CIP is; how the CIP process functions; the role of the CIP Editors; and how users should go about proposing, discussing and structuring a CIP. +A [Cardano Improvement Proposal (CIP)](./CIP-0001) is a formalised design document for the Cardano community and the name of the process by which such documents are produced and listed. A CIP provides information or describes a change to the Cardano ecosystem, processes, or environment concisely and in sufficient technical detail. In this CIP, we explain what a CIP is; how the CIP process functions; the role of the CIP Editors; and how users should go about proposing, discussing and structuring a CIP. The Cardano Foundation intends CIPs to be the primary mechanisms for proposing new features, collecting community input on an issue, and documenting design decisions that have gone into Cardano. Plus, because CIPs are text files in a versioned repository, their revision history is the historical record of significant changes affecting Cardano. +For more about the and human factors of the CIP process, and to learn how to get involved, click the Wiki tab above **[CIP Wiki](https://github.com/cardano-foundation/CIPs/wiki)**. + > **Note** For new CIP, a reference template is available in [.github/CIP-TEMPLATE.md](.github/CIP-TEMPLATE.md) ## Cardano Problem Statements (CPS) @@ -16,9 +18,7 @@ A [Cardano Problem Statement (CPS)](./CIP-9999) is a formalised document for the Extend or discuss ‘ideas’ in the [Developer Forums](https://forum.cardano.org/c/developers/cips/122), Cardano’s Official [Developer Telegram Group](https://t.me/CardanoDevelopersOfficial) or in `#developers` in Cardano Ambassadors Slack. -CIP editors will review discussions and progress in bi-weekly meetings held [on Discord](https://discord.gg/Jy9YM69Ezf), then transcribe and summarise them [in the BikweeklyMeetings folder](https://github.com/cardano-foundation/CIPs/tree/master/BiweeklyMeetings). - -CIP Editors meetings are public, recorded, and [published on Youtube](https://www.youtube.com/playlist?list=PL831pmH4tfw1YkMK4FhBzoHyuSaadjdxn): do join and participate in discussions/PRs of significance to you. +CIP editors facilitate discussions and progress submissions on GitHub, reviewing progress in bi-weekly meetings held [on Discord](https://discord.gg/J8sGdCuKhs) which are open to the public. The Discord server also has channels for CIP-based developer working groups. > **Note** To facilitate browsing and information sharing for non-Github users, an auto-generated site is also provided at [cips.cardano.org](https://cips.cardano.org/). From 372cba96ea21c6fd457cd0cda8bf419eb7528300 Mon Sep 17 00:00:00 2001 From: rphair Date: Wed, 9 Oct 2024 16:46:35 +0530 Subject: [PATCH 06/24] added $this to Discussions: --- CIP-0001/README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CIP-0001/README.md b/CIP-0001/README.md index f55b73b106..f6569af2d0 100644 --- a/CIP-0001/README.md +++ b/CIP-0001/README.md @@ -15,6 +15,7 @@ Discussions: - https://github.com/cardano-foundation/cips/pull/366 - https://github.com/cardano-foundation/cips/pull/331 - https://github.com/cardano-foundation/CIPs/tree/3da306f3bfe89fa7de8fe1bf7a436682aeee25c5/CIP-0001#abstract + - https://github.com/cardano-foundation/CIPs/pull/924 Created: 2020-03-21 License: CC-BY-4.0 --- From c8689149a08e4d5ab7dbd995e35a2f1c06ce5595 Mon Sep 17 00:00:00 2001 From: rphair Date: Wed, 9 Oct 2024 19:16:42 +0530 Subject: [PATCH 07/24] grammar fix: with vs. within --- CIP-0001/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CIP-0001/README.md b/CIP-0001/README.md index f6569af2d0..15410be46c 100644 --- a/CIP-0001/README.md +++ b/CIP-0001/README.md @@ -183,7 +183,7 @@ CIPs must indicate how the defined Specification is versioned. **Note** this do Authors are free to describe any approach to versioning that allows versioned alterations to be added without author oversight. Stipulating that the proposal must be superseded by another is also considered to be valid versioning. -A single Versioning scheme can be placed either as a subsection of the Specification section or in an optional Versioning top-level section near the end. If the Specification contains multiple specification subsections, each of these can have a Versioning subsection with it. +A single Versioning scheme can be placed either as a subsection of the Specification section or in an optional Versioning top-level section near the end. If the Specification contains multiple specification subsections, each of these can have a Versioning subsection within it. ##### Licensing From c19d3f208462e4c8f5256c5152c9821cfccb31ee Mon Sep 17 00:00:00 2001 From: rphair Date: Wed, 9 Oct 2024 19:18:44 +0530 Subject: [PATCH 08/24] clarified explanation of non-enlisted categories --- CIP-0001/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CIP-0001/README.md b/CIP-0001/README.md index 15410be46c..66a2fdbe89 100644 --- a/CIP-0001/README.md +++ b/CIP-0001/README.md @@ -252,7 +252,7 @@ This must be subdivided into two sub-sections: CIPs are classified into distinct categories that help organise (and thus, find) them. Categories are meant to be flexible and evolve as new domains emerge. Authors may leave the category as `?` should they not be sure under which category their proposal falls; editors will eventually assign one or reject the proposal altogether should it relate to an area where the CIP process does not apply. -Submission in these categories can be used whenever appropriate without following any particular submission guidelines: +Submissions can be made to these categories whenever relevant, without following any particular submission guidelines: Category | Description --- | --- From 8fea4b37cd56c32ea6f906bb3ed29345824b6464 Mon Sep 17 00:00:00 2001 From: rphair Date: Wed, 9 Oct 2024 19:20:29 +0530 Subject: [PATCH 09/24] removed long-standing white space from inside ordered list --- CIP-0001/README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/CIP-0001/README.md b/CIP-0001/README.md index 66a2fdbe89..13b51de55c 100644 --- a/CIP-0001/README.md +++ b/CIP-0001/README.md @@ -29,9 +29,7 @@ The Cardano Foundation intends CIPs to be the primary mechanisms for proposing n ## Motivation: why is this CIP necessary? CIPs aim to address two challenges mainly: - 1. The need for various parties to agree on a common approach to ease the interoperability of tools or interfaces. - 2. The need to propose and discuss changes to the protocol or established practice of the ecosystem. The CIP process does not _by itself_ offer any form of governance. For example, it does not govern the process by which proposed changes to the Cardano protocol are implemented and deployed. Yet, it is a crucial, community-driven component of the governance decision pipeline as it helps to collect thoughts and proposals in an organised fashion. Additionally, specific projects may choose to actively engage with the CIP process for some or all changes to their project. From 3f744a7690bdaca3bf67f4e487fc2252d780527b Mon Sep 17 00:00:00 2001 From: rphair Date: Wed, 9 Oct 2024 19:21:28 +0530 Subject: [PATCH 10/24] spelling fix: tenatively vs. tentatively --- CIP-0001/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CIP-0001/README.md b/CIP-0001/README.md index 13b51de55c..752f79f113 100644 --- a/CIP-0001/README.md +++ b/CIP-0001/README.md @@ -267,7 +267,7 @@ Category | Description Plutus | Changes or additions to Plutus, following the process described in [CIP-0035][] Ledger | For proposals regarding the Cardano ledger, following the process described in [CIP-0084][] -These tenatively enlisted categories await CIPs to describe any enlistment relationship: +These tentatively enlisted categories await CIPs to describe any enlistment relationship: Category | Description --- | --- From 1adf7c5a65b51bd44388400be8ffdcd0ee71a16b Mon Sep 17 00:00:00 2001 From: rphair Date: Wed, 9 Oct 2024 19:27:01 +0530 Subject: [PATCH 11/24] README updates: fix grammar & formatting in introduction --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a790274f26..137a674cd6 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,9 @@ A [Cardano Improvement Proposal (CIP)](./CIP-0001) is a formalised design docume The Cardano Foundation intends CIPs to be the primary mechanisms for proposing new features, collecting community input on an issue, and documenting design decisions that have gone into Cardano. Plus, because CIPs are text files in a versioned repository, their revision history is the historical record of significant changes affecting Cardano. -For more about the and human factors of the CIP process, and to learn how to get involved, click the Wiki tab above **[CIP Wiki](https://github.com/cardano-foundation/CIPs/wiki)**. +For more about the human factors of the CIP process, and to learn how to get involved, click the Wiki tab above (**[CIP Wiki](https://github.com/cardano-foundation/CIPs/wiki)**). -> **Note** For new CIP, a reference template is available in [.github/CIP-TEMPLATE.md](.github/CIP-TEMPLATE.md) +> **Note** For new CIPs, a reference template is available in [.github/CIP-TEMPLATE.md](.github/CIP-TEMPLATE.md) ## Cardano Problem Statements (CPS) From ff8fe214163f0235b3d5fe73cb565060af2839fe Mon Sep 17 00:00:00 2001 From: rphair Date: Wed, 9 Oct 2024 19:28:15 +0530 Subject: [PATCH 12/24] corresponding grammar fix in CPS introduction --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 137a674cd6..331df2b90a 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ For more about the human factors of the CIP process, and to learn how to get inv A [Cardano Problem Statement (CPS)](./CIP-9999) is a formalised document for the Cardano ecosystem and the name of the process by which such documents are produced and listed. CPSs are meant to complement CIPs and live side-by-side in the CIP repository as first-class citizens. -> **Note** For new CPS, a reference template is available in [.github/CPS-TEMPLATE.md](.github/CPS-TEMPLATE.md) +> **Note** For new CPSs, a reference template is available in [.github/CPS-TEMPLATE.md](.github/CPS-TEMPLATE.md) ## Communication Channels From 1edc924941ecb457ab313e677f6978d2ce5e0ce4 Mon Sep 17 00:00:00 2001 From: rphair Date: Wed, 9 Oct 2024 19:34:26 +0530 Subject: [PATCH 13/24] refined description of Discord server working groups --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 331df2b90a..2bc544375f 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ A [Cardano Problem Statement (CPS)](./CIP-9999) is a formalised document for the Extend or discuss ‘ideas’ in the [Developer Forums](https://forum.cardano.org/c/developers/cips/122), Cardano’s Official [Developer Telegram Group](https://t.me/CardanoDevelopersOfficial) or in `#developers` in Cardano Ambassadors Slack. -CIP editors facilitate discussions and progress submissions on GitHub, reviewing progress in bi-weekly meetings held [on Discord](https://discord.gg/J8sGdCuKhs) which are open to the public. The Discord server also has channels for CIP-based developer working groups. +CIP editors facilitate discussions and progress submissions on GitHub, reviewing progress in bi-weekly meetings held [on Discord](https://discord.gg/J8sGdCuKhs) which are open to the public. The Discord server also has channels for developer working groups to discuss details and implementations of selected CIPs. > **Note** To facilitate browsing and information sharing for non-Github users, an auto-generated site is also provided at [cips.cardano.org](https://cips.cardano.org/). From 0027c630b3c70e02422814da61492ae6ef20e9b6 Mon Sep 17 00:00:00 2001 From: Ryan Date: Thu, 10 Oct 2024 22:09:32 +0100 Subject: [PATCH 14/24] spelling mistake --- CIP-0001/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CIP-0001/README.md b/CIP-0001/README.md index 752f79f113..3bf5e38e70 100644 --- a/CIP-0001/README.md +++ b/CIP-0001/README.md @@ -313,7 +313,7 @@ Proposals must be submitted to the [cardano-foundation/CIPs][Repository] reposit ###### Naming CIPs with similar subjects -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): +When a CIP title *and* subject matter share a common element, begin the CIP title with that common element and end it with the specific portion, delimited with the `-` character. Example (CIP-0095): > *Web-Wallet Bridge **-** Governance* From 263ec44b9a38c7dc2367d10e8a0784df81ec4622 Mon Sep 17 00:00:00 2001 From: Robert Phair Date: Fri, 11 Oct 2024 10:22:07 +0530 Subject: [PATCH 15/24] list of noun phrases: delimit with , vs. ; for conventionality Co-authored-by: Ryan --- CIP-0001/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CIP-0001/README.md b/CIP-0001/README.md index 3bf5e38e70..38cff149b3 100644 --- a/CIP-0001/README.md +++ b/CIP-0001/README.md @@ -22,7 +22,7 @@ License: CC-BY-4.0 ## Abstract -A Cardano Improvement Proposal (CIP) is a formalised design document for the Cardano community and the name of the process by which such documents are produced and listed. A CIP provides information or describes a change to the Cardano ecosystem, processes, or environment concisely and in sufficient technical detail. In this CIP, we explain what a CIP is; how the CIP process functions; the role of the CIP Editors; and how users should go about proposing, discussing and structuring a CIP. +A Cardano Improvement Proposal (CIP) is a formalised design document for the Cardano community and the name of the process by which such documents are produced and listed. A CIP provides information or describes a change to the Cardano ecosystem, processes, or environment concisely and in sufficient technical detail. In this CIP, we explain what a CIP is, how the CIP process functions, the role of the CIP Editors, and how users should go about proposing, discussing, and structuring a CIP. The Cardano Foundation intends CIPs to be the primary mechanisms for proposing new features, collecting community input on an issue, and documenting design decisions that have gone into Cardano. Plus, because CIPs are text files in a versioned repository, their revision history is the historical record of significant changes affecting Cardano. From 3dc59c076828aaeaead85e4372d763dcd592eba8 Mon Sep 17 00:00:00 2001 From: Robert Phair Date: Fri, 11 Oct 2024 10:24:16 +0530 Subject: [PATCH 16/24] fix non-canonical repo spelling in example header Co-authored-by: Ryan --- CIP-0001/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CIP-0001/README.md b/CIP-0001/README.md index 38cff149b3..2d61e8269d 100644 --- a/CIP-0001/README.md +++ b/CIP-0001/README.md @@ -122,7 +122,7 @@ Authors: - Duncan Coutts Implementors: N/A Discussions: - - https://github.com/cardano-foundation/cips/pull/366 + - https://github.com/cardano-foundation/CIPs/pull/366 Created: 2020-03-21 License: CC-BY-4.0 --- From 4225487cc127d23836fbe1865d210da82d556778 Mon Sep 17 00:00:00 2001 From: rphair Date: Fri, 11 Oct 2024 10:27:02 +0530 Subject: [PATCH 17/24] fix non-canonical repo spellings in actual header --- CIP-0001/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CIP-0001/README.md b/CIP-0001/README.md index 2d61e8269d..9336f0f4bf 100644 --- a/CIP-0001/README.md +++ b/CIP-0001/README.md @@ -12,8 +12,8 @@ Authors: - Robert Phair Implementors: N/A Discussions: - - https://github.com/cardano-foundation/cips/pull/366 - - https://github.com/cardano-foundation/cips/pull/331 + - https://github.com/cardano-foundation/CIPs/pull/366 + - https://github.com/cardano-foundation/CIPs/pull/331 - https://github.com/cardano-foundation/CIPs/tree/3da306f3bfe89fa7de8fe1bf7a436682aeee25c5/CIP-0001#abstract - https://github.com/cardano-foundation/CIPs/pull/924 Created: 2020-03-21 From 0797dfa3e9291db5ffc9eb144452e7eca1602b32 Mon Sep 17 00:00:00 2001 From: Robert Phair Date: Fri, 11 Oct 2024 10:30:14 +0530 Subject: [PATCH 18/24] specify yaml for header code block Co-authored-by: Ryan --- CIP-0001/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CIP-0001/README.md b/CIP-0001/README.md index 9336f0f4bf..5f66f582a7 100644 --- a/CIP-0001/README.md +++ b/CIP-0001/README.md @@ -129,7 +129,7 @@ License: CC-BY-4.0 ``` Especially because Markdown link syntax is not supported in the header preamble, labels can be added to clarify list items; e.g.: -``` +```yaml Implementors: - Mlabs: https://mlabs.city ``` From 005aaf898843044abbb1b59f1bf3e72d9b4d241d Mon Sep 17 00:00:00 2001 From: Robert Phair Date: Fri, 11 Oct 2024 10:35:58 +0530 Subject: [PATCH 19/24] fix spelling: enslisted vs. enlisted Co-authored-by: Ryan --- CIP-0001/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CIP-0001/README.md b/CIP-0001/README.md index 5f66f582a7..f9b1cc7fbe 100644 --- a/CIP-0001/README.md +++ b/CIP-0001/README.md @@ -260,7 +260,7 @@ Tokens | About tokens (fungible or non-fungible) and minting policies in gener Metadata | For proposals around metadata (on-chain or off-chain) Tools | A broad category for ecosystem features not falling into any other category -Additionally, representatives of ecosystem categories may explicitly _enlist_ their categories (see next section) to suggest a closer relationship with the CIP process. The following categories are confirmed as enslisted according to CIPs which define that relationship: +Additionally, representatives of ecosystem categories may explicitly _enlist_ their categories (see next section) to suggest a closer relationship with the CIP process. The following categories are confirmed as enlisted according to CIPs which define that relationship: Category | Description --- | --- From 7b2e02b79e5ee6f32353152df5aba5048048a11c Mon Sep 17 00:00:00 2001 From: Robert Phair Date: Fri, 11 Oct 2024 10:50:37 +0530 Subject: [PATCH 20/24] embedded CIP enlistment badge: fix syntax + demote blockquote Co-authored-by: Ryan --- CIP-0001/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CIP-0001/README.md b/CIP-0001/README.md index f9b1cc7fbe..5b349c2e77 100644 --- a/CIP-0001/README.md +++ b/CIP-0001/README.md @@ -293,7 +293,7 @@ Any guidelines for this cooperation should be described by a dedicated CIP whene Editors occasionally invite representatives from enlisted categories to speak during review meetings and solicit them for ultimate approvals of proposals in their area of expertise. -> **Note** Optionally, projects may show their enlisting using the following badge on their introductory README: ![](https://github.com/cardano-foundation/CIPs](https://raw.githubusercontent.com/cardano-foundation/CIPs/master/.github/badge.svg) +**Note** Optionally, projects may show their enlisting using the following badge on their introductory README: ![https://github.com/cardano-foundation/CIPs](https://raw.githubusercontent.com/cardano-foundation/CIPs/master/.github/badge.svg) > > ```md > ![https://github.com/cardano-foundation/CIPs](https://raw.githubusercontent.com/cardano-foundation/CIPs/master/.github/badge.svg) From d67351c40b3df549bc96095ad8e27a4ae136189e Mon Sep 17 00:00:00 2001 From: Robert Phair Date: Fri, 11 Oct 2024 10:52:13 +0530 Subject: [PATCH 21/24] fix plural for CPS in original code Co-authored-by: Ryan --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2bc544375f..1fe1f49f91 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ For more about the human factors of the CIP process, and to learn how to get inv A [Cardano Problem Statement (CPS)](./CIP-9999) is a formalised document for the Cardano ecosystem and the name of the process by which such documents are produced and listed. CPSs are meant to complement CIPs and live side-by-side in the CIP repository as first-class citizens. -> **Note** For new CPSs, a reference template is available in [.github/CPS-TEMPLATE.md](.github/CPS-TEMPLATE.md) +> **Note** For new CPSs, a reference template is available in [.github/CPS-TEMPLATE.md](./.github/CPS-TEMPLATE.md) ## Communication Channels From 41729cab037f776ed6ae6ef7d20881ccd45081f3 Mon Sep 17 00:00:00 2001 From: Robert Phair Date: Fri, 11 Oct 2024 10:55:07 +0530 Subject: [PATCH 22/24] consistently use anchored relative pathname for both template files Co-authored-by: Ryan --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 1fe1f49f91..7fb8707ad5 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ The Cardano Foundation intends CIPs to be the primary mechanisms for proposing n For more about the human factors of the CIP process, and to learn how to get involved, click the Wiki tab above (**[CIP Wiki](https://github.com/cardano-foundation/CIPs/wiki)**). -> **Note** For new CIPs, a reference template is available in [.github/CIP-TEMPLATE.md](.github/CIP-TEMPLATE.md) +> **Note** For new CIPs, a reference template is available in [.github/CIP-TEMPLATE.md](./.github/CIP-TEMPLATE.md) ## Cardano Problem Statements (CPS) From f1f04ac8b544bfd07c8c23c5e6f56342029ff7b1 Mon Sep 17 00:00:00 2001 From: rphair Date: Fri, 11 Oct 2024 16:34:00 +0530 Subject: [PATCH 23/24] changed YAML label example to tag Discussions + illustrate multi word keywords Co-authored-by: Ryan --- CIP-0001/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CIP-0001/README.md b/CIP-0001/README.md index 5b349c2e77..70247dc298 100644 --- a/CIP-0001/README.md +++ b/CIP-0001/README.md @@ -130,8 +130,8 @@ License: CC-BY-4.0 Especially because Markdown link syntax is not supported in the header preamble, labels can be added to clarify list items; e.g.: ```yaml -Implementors: - - Mlabs: https://mlabs.city +Discussions: + - Original-PR: https://github.com/cardano-foundation/CIPs/pull/366 ``` > **Note** A reference template is available in [.github/CIP-TEMPLATE.md][CIP-TEMPLATE.md] From 856e1e5f10bc009f3dce8e6efbfb9256458680d7 Mon Sep 17 00:00:00 2001 From: Robert Phair Date: Mon, 14 Oct 2024 12:36:03 +0530 Subject: [PATCH 24/24] 2 spelling mistakes on same line Co-authored-by: Thomas Vellekoop <107037423+perturbing@users.noreply.github.com> --- CIP-0001/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CIP-0001/README.md b/CIP-0001/README.md index 70247dc298..67ecd886a2 100644 --- a/CIP-0001/README.md +++ b/CIP-0001/README.md @@ -278,7 +278,7 @@ Network | Specifications and implementations of Cardano's network protocols an #### Project Enlisting Project representatives intending to follow an "enlisted" category above agree to coordinate with related development by sharing efforts to review and validate new proposals. -It should be noted that single organisations can no longer repesent any ecosystem or development category, which makes these enlistment guidelines both decentralised and cooperative, including whenver possible: +It should be noted that single organisations can no longer represent any ecosystem or development category, which makes these enlistment guidelines both decentralised and cooperative, including whenever possible: - allocating time to **review** proposals from actors of the community when solicited by editors (i.e. after one first round of reviews); - defining additional rules and processes whereby external actors can engage with their project as part of the CIP process;