From 7576c34afe18ab36d690ae8d769b6040d4f54a84 Mon Sep 17 00:00:00 2001 From: jcstein Date: Wed, 24 Jul 2024 23:12:44 -0400 Subject: [PATCH 1/3] feat: resolve links to github on site --- README.md | 4 +--- cips/README.md | 38 +++++++++++++++++++------------------- cips/cip-1.md | 12 ++++++------ cips/cip-10.md | 2 +- cips/cip-11.md | 2 +- cips/cip-12.md | 2 +- cips/cip-14.md | 2 +- cips/cip-15.md | 2 +- cips/cip-16.md | 2 +- cips/cip-17.md | 2 +- cips/cip-18.md | 2 +- cips/cip-19.md | 2 +- cips/cip-2.md | 2 +- cips/cip-20.md | 2 +- cips/cip-21.md | 2 +- cips/cip-22.md | 2 +- cips/cip-23.md | 2 +- cips/cip-3.md | 2 +- cips/cip-4.md | 2 +- cips/cip-5.md | 2 +- cips/cip-6.md | 2 +- cips/cip-9.md | 2 +- cips/cip-template.md | 2 +- 23 files changed, 46 insertions(+), 48 deletions(-) diff --git a/README.md b/README.md index 1b5513eb..d9af6d53 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,4 @@ -# @celestiaorg/CIPs - -## Celestia Improvement Proposal (CIP) process repository +# Celestia Improvement Proposal (CIP) process repository See [/cips/README.md](./cips/README.md) for an overview of the CIP process. diff --git a/cips/README.md b/cips/README.md index a64a8d4b..30e352f3 100644 --- a/cips/README.md +++ b/cips/README.md @@ -26,28 +26,28 @@ Read [CIP-1](./cip-1.md) for information on the CIP process. | № | Title | Author(s) | |:-----------------:|:----------------------------------------------------------------------------:|:------------------------------------------------------------------------------------------------------------------------------------------------------:| | [1](./cip-1.md) | Celestia Improvement Proposal Process and Guidelines | Yaz Khoury | -| [2](./cip-2.md) | CIP Editor Handbook | Yaz Khoury (@YazzyYaz) | -| [3](./cip-3.md) | Process for Approving External Resources | Yaz Khoury (@YazzyYaz) | -| [4](./cip-4.md) | Standardize data expiry time for pruned nodes | Mustafa Al-Bassam (@musalbas), Rene Lubov (@renaynay), Ramin Keene (@ramin) | -| [5](./cip-5.md) | Rename data availability to data publication | msfew (@fewwwww), Kartin, Xiaohang Yu (@xhyumiracle) | -| [6](./cip-6.md) | Enforce payment of the gas for a transaction based on a global minimum price | Callum Waters (@cmwaters) | +| [2](./cip-2.md) | CIP Editor Handbook | Yaz Khoury ([@YazzyYaz](https://github.com/YazzyYaz)) | +| [3](./cip-3.md) | Process for Approving External Resources | Yaz Khoury ([@YazzyYaz](https://github.com/YazzyYaz)) | +| [4](./cip-4.md) | Standardize data expiry time for pruned nodes | Mustafa Al-Bassam ([@musalbas](https://github.com/musalbas)), Rene Lubov ([@renaynay](https://github.com/renaynay)), Ramin Keene ([@ramin](https://github.com/ramin)) | +| [5](./cip-5.md) | Rename data availability to data publication | msfew ([@fewwwww](https://github.com/fewwwww)), Kartin, Xiaohang Yu ([@xhyumiracle](https://github.com/xhyumiracle)) | +| [6](./cip-6.md) | Enforce payment of the gas for a transaction based on a global minimum price | Callum Waters ([@cmwaters](https://github.com/cmwaters)) | | [7](./cip-7.md) | Managing Working Groups in the Celestia Improvement Proposal Process | Yaz Khoury | | [8](./cip-8.md) | Roles and Responsibilities of Working Group Chairs in the CIP Process | Yaz Khoury | -| [9](./cip-9.md) | Packet Forward Middleware | Alex Cheng (@akc2267) | -| [10](./cip-10.md) | Coordinated network upgrades | Callum Waters (@cmwaters) | -| [11](./cip-11.md) | Refund unspent gas | Rootul Patel (@rootulp) | -| [12](./cip-12.md) | ICS-29 Relayer Incentivisation Middleware | Susannah Evans @womensrights, Aditya Sripal @AdityaSripal | +| [9](./cip-9.md) | Packet Forward Middleware | Alex Cheng ([@akc2267](https://github.com/akc2267)) | +| [10](./cip-10.md) | Coordinated network upgrades | Callum Waters ([@cmwaters](https://github.com/cmwaters)) | +| [11](./cip-11.md) | Refund unspent gas | Rootul Patel ([@rootulp](https://github.com/rootulp)) | +| [12](./cip-12.md) | ICS-29 Relayer Incentivisation Middleware | Susannah Evans ([@womensrights](https://github.com/womensrights)), Aditya Sripal ([@AdityaSripal](https://github.com/AdityaSripal)) | | [13](./cip-13.md) | On-chain Governance Parameters for Celestia Network | Yaz Khoury , Evan Forbes | -| [14](./cip-14.md) | ICS-27 Interchain Accounts | Susannah Evans (@womensrights), Aidan Salzmann (@asalzmann), Sam Pochyly (@sampocs) | -| [15](./cip-15.md) | Discourage memo usage | Rootul Patel (@rootulp), NashQueue (@nashqueue) | -| [16](./cip-16.md) | Make Security Related Governance Parameters Immutable | Mingpei CAO (@caomingpei) | -| [17](./cip-17.md) | Lemongrass Hardfork | Evan Forbes (@evan-forbes) | -| [18](./cip-18.md) | Standardised Gas and Pricing Estimation Interface | Callum Waters (@cmwaters) | -| [19](./cip-19.md) | Shwap Protocol | Hlib Kanunnikov (@Wondertan) | -| [20](./cip-20.md) | Disable Blobstream module | Rootul Patel (@rootulp) | -| [21](./cip-21.md) | Introduce blob type with verified signer | Callum Waters (@cmwaters) | -| [22](./cip-22.md) | Removing the IndexWrapper | NashQueue (@Nashqueue) | -| [23](./cip-23.md) | Coordinated prevote times | Callum Waters (@cmwaters) | +| [14](./cip-14.md) | ICS-27 Interchain Accounts | Susannah Evans ([@womensrights](https://github.com/womensrights)), Aidan Salzmann ([@asalzmann](https://github.com/asalzmann)), Sam Pochyly ([@sampocs](https://github.com/sampocs)) | +| [15](./cip-15.md) | Discourage memo usage | Rootul Patel ([@rootulp](https://github.com/rootulp)), NashQueue ([@nashqueue](https://github.com/nashqueue)) | +| [16](./cip-16.md) | Make Security Related Governance Parameters Immutable | Mingpei CAO ([@caomingpei](https://github.com/caomingpei)) | +| [17](./cip-17.md) | Lemongrass Hardfork | Evan Forbes ([@evan-forbes](https://github.com/evan-forbes)) | +| [18](./cip-18.md) | Standardised Gas and Pricing Estimation Interface | Callum Waters ([@cmwaters](https://github.com/cmwaters)) | +| [19](./cip-19.md) | Shwap Protocol | Hlib Kanunnikov ([@Wondertan](https://github.com/Wondertan)) | +| [20](./cip-20.md) | Disable Blobstream module | Rootul Patel ([@rootulp](https://github.com/rootulp)) | +| [21](./cip-21.md) | Introduce blob type with verified signer | Callum Waters ([@cmwaters](https://github.com/cmwaters)) | +| [22](./cip-22.md) | Removing the IndexWrapper | NashQueue ([@Nashqueue](https://github.com/Nashqueue)) | +| [23](./cip-23.md) | Coordinated prevote times | Callum Waters ([@cmwaters](https://github.com/cmwaters)) | ## Contributing diff --git a/cips/cip-1.md b/cips/cip-1.md index 6fee1be7..644ce7fc 100644 --- a/cips/cip-1.md +++ b/cips/cip-1.md @@ -350,11 +350,11 @@ value must be: or -> Random J. User (@username) +> Random J. User ([@username](https://github.com/username)) or -> Random J. User (@username) <> +> Random J. User ([@username](https://github.com/username) <> if the email address and/or GitHub username is included, and @@ -580,10 +580,10 @@ decision (it's not like such decisions can't be reversed :)). The current CIP editors are -* Yaz Khoury (@YazzyYaz) -* Josh Stein (@jcstein) -* Ethan Buchman (@ebuchman) -* Rootul Patel (@rootulp) +* Yaz Khoury ([@YazzyYaz](https://github.com/YazzyYaz)) +* Josh Stein ([@jcstein](https://github.com/jcstein)) +* Ethan Buchman ([@ebuchman](https://github.com/ebuchman)) +* Rootul Patel ([@rootulp](https://github.com/rootulp)) If you would like to become a CIP editor, please check [CIP-2](./cip-2.md). diff --git a/cips/cip-10.md b/cips/cip-10.md index ccfe878b..51025375 100644 --- a/cips/cip-10.md +++ b/cips/cip-10.md @@ -2,7 +2,7 @@ | - | - | | title | Coordinated network upgrades | | description | Protocol for coordinating major network upgrades | -| author | Callum Waters (@cmwaters) | +| author | Callum Waters ([@cmwaters](https://github.com/cmwaters)) | | discussions-to | | | status | Final | | type | Standards Track | diff --git a/cips/cip-11.md b/cips/cip-11.md index 857c9b49..56b2baa1 100644 --- a/cips/cip-11.md +++ b/cips/cip-11.md @@ -2,7 +2,7 @@ | - | - | | title | Refund unspent gas | | description | Refund allocated but unspent gas to the transaction fee payer. | -| author | Rootul Patel (@rootulp) | +| author | Rootul Patel ([@rootulp](https://github.com/rootulp)) | | discussions-to | | | status | Withdrawn | | withdrawal-reason | The mitigation strategies for the security considerations were deemed too complex. | diff --git a/cips/cip-12.md b/cips/cip-12.md index 10cb8328..74002d73 100644 --- a/cips/cip-12.md +++ b/cips/cip-12.md @@ -2,7 +2,7 @@ | - | - | | title | ICS-29 Relayer Incentivisation Middleware | | description | Adding ics-29 to Celestia to move towards sustainable relayer funding for IBC | -| author | Susannah Evans (@womensrights), Aditya Sripal (@AdityaSripal) | +| author | Susannah Evans ([@womensrights](https://github.com/womensrights)), Aditya Sripal ([@AdityaSripal](https://github.com/AdityaSripal)) | | discussions-to | | | status | Review | | type | Standards Track | diff --git a/cips/cip-14.md b/cips/cip-14.md index c0e1197c..c7687142 100644 --- a/cips/cip-14.md +++ b/cips/cip-14.md @@ -2,7 +2,7 @@ | - | - | | title | ICS-27 Interchain Accounts | | description | Adding ICS-27 Interchain Accounts to Celestia to enable cross-chain account management | -| author | Susannah Evans (@womensrights), Aidan Salzmann (@asalzmann), Sam Pochyly (@sampocs) | +| author | Susannah Evans ([@womensrights](https://github.com/womensrights)), Aidan Salzmann ([@asalzmann](https://github.com/asalzmann)), Sam Pochyly ([@sampocs](https://github.com/sampocs)) | | discussions-to | | | status | Final | | type | Standards Track | diff --git a/cips/cip-15.md b/cips/cip-15.md index 83aa6000..bf5145e9 100644 --- a/cips/cip-15.md +++ b/cips/cip-15.md @@ -2,7 +2,7 @@ | - | - | | title | Discourage memo usage | | description | Discourage memo usage by modifying two auth params. | -| author | Rootul Patel (@rootulp), NashQueue (@nashqueue) | +| author | Rootul Patel ([@rootulp](https://github.com/rootulp)), NashQueue ([@nashqueue](https://github.com/nashqueue)) | | discussions-to | | | status | Draft | | type | Standards Track | diff --git a/cips/cip-16.md b/cips/cip-16.md index 24aab15c..3d3768ee 100644 --- a/cips/cip-16.md +++ b/cips/cip-16.md @@ -2,7 +2,7 @@ | - | - | | title | Make Security Related Governance Parameters Immutable | | description | Consensus-related parameters should not be modified via on-chain governance in the Celestia network. | -| author | Mingpei CAO (@caomingpei) | +| author | [@caomingpei](https://github.com/caomingpei) | | discussions-to | | | status | Draft | | type | Standards Track | diff --git a/cips/cip-17.md b/cips/cip-17.md index 42a5dd31..cd18027b 100644 --- a/cips/cip-17.md +++ b/cips/cip-17.md @@ -2,7 +2,7 @@ | - | - | | title | Lemongrass Hardfork | | description | Reference specifications included in the Lemongrass Hardfork | -| author | Evan Forbes (@evan-forbes) | +| author | [@evan-forbes](https://github.com/evan-forbes) | | discussions-to | | | status | Final | | type | Meta | diff --git a/cips/cip-18.md b/cips/cip-18.md index 19487d1b..f480745b 100644 --- a/cips/cip-18.md +++ b/cips/cip-18.md @@ -2,7 +2,7 @@ | - | - | | title | Standardised Gas and Pricing Estimation Interface | | description | A standardised interface for estimating gas usage and gas pricing for transactions | -| author | Callum Waters (@cmwaters) | +| author | Callum Waters ([@cmwaters](https://github.com/cmwaters)) | | discussions-to | | | status | Review | | type | Standards Track | diff --git a/cips/cip-19.md b/cips/cip-19.md index be7ff47c..0030c952 100644 --- a/cips/cip-19.md +++ b/cips/cip-19.md @@ -2,7 +2,7 @@ | - | - | | title | Shwap Protocol | | description | Shwap - a new messaging framework for DA and sampling | -| author | Hlib Kanunnikov (@Wondertan) | +| author | Hlib Kanunnikov ([@Wondertan](https://github.com/Wondertan)) | | discussions-to | | | status | Review | | type | Standards Track | diff --git a/cips/cip-2.md b/cips/cip-2.md index de5882a1..f54f175c 100644 --- a/cips/cip-2.md +++ b/cips/cip-2.md @@ -2,7 +2,7 @@ | - | - | | title | CIP Editor Handbook | | description | Handy reference for CIP editors and those who want to become one | -| author | Yaz Khoury (@YazzyYaz) | +| author | Yaz Khoury ([@YazzyYaz](https://github.com/YazzyYaz)) | | discussions-to | | | status | Draft | | type | Informational | diff --git a/cips/cip-20.md b/cips/cip-20.md index 8c954f9d..f3c8da1c 100644 --- a/cips/cip-20.md +++ b/cips/cip-20.md @@ -2,7 +2,7 @@ | - | - | | title | Disable Blobstream module | | description | Disable the Blobstream state machine module | -| author | Rootul Patel (@rootulp) | +| author | Rootul Patel ([@rootulp](https://github.com/rootulp)) | | discussions-to | | | status | Final | | type | Standards Track | diff --git a/cips/cip-21.md b/cips/cip-21.md index 3b55bc5c..1854438e 100644 --- a/cips/cip-21.md +++ b/cips/cip-21.md @@ -2,7 +2,7 @@ | - | - | | title | Introduce blob type with verified signer | | description | Introduce a new blob type that can be submitted whereby the signer address is included and verified. | -| author | Callum Waters (@cmwaters) | +| author | Callum Waters ([@cmwaters](https://github.com/cmwaters)) | | discussions-to | | | status | Review | | type | Standards Track | diff --git a/cips/cip-22.md b/cips/cip-22.md index 28b38685..d413536a 100644 --- a/cips/cip-22.md +++ b/cips/cip-22.md @@ -1,7 +1,7 @@ | cip | 22 | | - | - | | title | Removing the IndexWrapper | -| author | NashQueue (@Nashqueue) | +| author | NashQueue ([@Nashqueue](https://github.com/Nashqueue)) | | discussions-to | | | status | Review | | type | Standards Track | diff --git a/cips/cip-23.md b/cips/cip-23.md index f84842b9..8e4cfbef 100644 --- a/cips/cip-23.md +++ b/cips/cip-23.md @@ -2,7 +2,7 @@ | - | - | | title | Coordinated prevote times | | description | Scheduled prevote times for consistent blocks | -| author | Callum Waters (@cmwaters) | +| author | Callum Waters ([@cmwaters](https://github.com/cmwaters)) | | discussions-to | | | status | Draft | | type | Standards Track | diff --git a/cips/cip-3.md b/cips/cip-3.md index 3792ae18..e9633aec 100644 --- a/cips/cip-3.md +++ b/cips/cip-3.md @@ -2,7 +2,7 @@ | - | - | | title | Process for Approving External Resources | | description | Requirements and process for allowing new origins of external resources | -| author | Yaz Khoury (@YazzyYaz) | +| author | Yaz Khoury ([@YazzyYaz](https://github.com/YazzyYaz)) | | discussions-to | | | status | Draft | | type | Meta | diff --git a/cips/cip-4.md b/cips/cip-4.md index d01e9adb..29c75451 100644 --- a/cips/cip-4.md +++ b/cips/cip-4.md @@ -2,7 +2,7 @@ | - | - | | title | Standardize data expiry time for pruned nodes | | description | Standardize default data expiry time for pruned nodes to 30 days + 1 hour worth of seconds (2595600 seconds). | -| author | Mustafa Al-Bassam (@musalbas), Rene Lubov (@renaynay), Ramin Keene (@ramin) | +| author | Mustafa Al-Bassam ([@musalbas](https://github.com/musalbas)), Rene Lubov ([@renaynay](https://github.com/renaynay)), Ramin Keene ([@ramin](https://github.com/ramin)) | | discussions-to | | | status | Final | | type | Standards Track | diff --git a/cips/cip-5.md b/cips/cip-5.md index 17cfcc46..b927d4fb 100644 --- a/cips/cip-5.md +++ b/cips/cip-5.md @@ -2,7 +2,7 @@ | - | - | | title | Rename data availability to data publication | | description | Renaming data availability to data publication to better reflect the message | -| author | msfew (@fewwwww) , Kartin , Xiaohang Yu (@xhyumiracle) | +| author | msfew ([@fewwwww](https://github.com/fewwwww)) , Kartin , Xiaohang Yu ([@xhyumiracle](https://github.com/xhyumiracle)) | | discussions-to | | | status | Review | | type | Informational | diff --git a/cips/cip-6.md b/cips/cip-6.md index ae2b5152..aa535a62 100644 --- a/cips/cip-6.md +++ b/cips/cip-6.md @@ -2,7 +2,7 @@ | - | - | | title | Mininum gas price enforcement | | description | Enforce payment of the gas for a transaction based on a governance modifiable global minimum gas price | -| author | Callum Waters (@cmwaters) | +| author | Callum Waters ([@cmwaters](https://github.com/cmwaters)) | | discussions-to | | | status | Final | | type | Standards Track | diff --git a/cips/cip-9.md b/cips/cip-9.md index 5663ced6..cecb3f42 100644 --- a/cips/cip-9.md +++ b/cips/cip-9.md @@ -2,7 +2,7 @@ | - | - | | title | Packet Forward Middleware | | description | Adopt Packet Forward Middleware for multi-hop IBC and path unwinding | -| author | Alex Cheng (@akc2267) | +| author | Alex Cheng ([@akc2267](https://github.com/akc2267)) | | discussions-to | | | status | Final | | type | Standards Track | diff --git a/cips/cip-template.md b/cips/cip-template.md index f09d83ab..b16f0705 100644 --- a/cips/cip-template.md +++ b/cips/cip-template.md @@ -2,7 +2,7 @@ | - | - | | title | The CIP title is a few words, not a complete sentence | | description | Description is one full (short) sentence | -| author | a comma separated list of the author’s or authors’ name + GitHub username (in parenthesis), or name and email (in angle brackets). Example, FirstName LastName (@GitHubUsername), FirstName LastName , FirstName (@GitHubUsername) and GitHubUsername (@GitHubUsername) | +| author | a comma separated list of the author’s or authors’ name + GitHub username (in parenthesis), or name and email (in angle brackets). Example, FirstName LastName ([@GitHubUsername](https://github.com/GitHubUsername)), FirstName LastName , FirstName ([@GitHubUsername](https://github.com/GitHubUsername)) and GitHubUsername ([@GitHubUsername](https://github.com/GitHubUsername)) | | discussions-to | URL | | status | Draft | | type | Standards Track, Meta, or Informational | From e210174462bd76997bb1e4e003b897b37b74d78a Mon Sep 17 00:00:00 2001 From: Josh Stein <46639943+jcstein@users.noreply.github.com> Date: Thu, 25 Jul 2024 11:05:13 -0400 Subject: [PATCH 2/3] Update README.md Co-authored-by: Rootul P --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d9af6d53..7a88fe41 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Celestia Improvement Proposal (CIP) process repository +# Celestia Improvement Proposal (CIP) See [/cips/README.md](./cips/README.md) for an overview of the CIP process. From 46e62ec29b0f39c5b5663a41484fbb2fd3c613ab Mon Sep 17 00:00:00 2001 From: Josh Stein <46639943+jcstein@users.noreply.github.com> Date: Thu, 25 Jul 2024 11:05:56 -0400 Subject: [PATCH 3/3] Apply suggestions from code review --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 7a88fe41..e0b1aa0a 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Celestia Improvement Proposal (CIP) +# Celestia Improvement Proposals (CIPs) See [/cips/README.md](./cips/README.md) for an overview of the CIP process.