From 29fba394856376c1a88b76ba1220458f9e2c28e9 Mon Sep 17 00:00:00 2001 From: Ethan Buchman Date: Wed, 6 Mar 2024 19:44:17 -0500 Subject: [PATCH 1/6] Update cip-template.md with parameter section --- cips/cip-template.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/cips/cip-template.md b/cips/cip-template.md index c9c4961..b604b15 100644 --- a/cips/cip-template.md +++ b/cips/cip-template.md @@ -42,6 +42,18 @@ It is recommended to follow RFC 2119 and RFC 8170. Do not remove the key word de The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119 and RFC 8174. +## Parameters + +The parameters section should summarize any changes to global parameters, including any new parameters. All mainnet parameters are tracked in [CIP-13](./cip-13.md). Once a CIP is accepted and deployed to mainnet, CIP-13 MUST be updated with these parameter changes. If there are no parameter changes in the CIP, this section can be omitted. + +**TODO: Remove the previous comments and update the following table before submitting** + +| Parameter | Default | Summary | Changeable via Governance | +|---------------|---------|------------------------------------------------------------------------------------------------------------------------|---------------------------| +| module1.Name1 | Value1 | Description1 | bool | +| module2.Name2 | Value2 | Description2 | bool | + + ## Rationale The rationale fleshes out the specification by describing what motivated the design and why particular design decisions were made. It should describe alternate designs that were considered and related work, e.g. how the feature is supported in other languages. From 04d94613de7c3b67c3d2f55a02dbabd932290f52 Mon Sep 17 00:00:00 2001 From: Ethan Buchman Date: Wed, 6 Mar 2024 19:46:30 -0500 Subject: [PATCH 2/6] Update cip-1.md with parameter section --- cips/cip-1.md | 1 + 1 file changed, 1 insertion(+) diff --git a/cips/cip-1.md b/cips/cip-1.md index 3f18bb4..53d17e7 100644 --- a/cips/cip-1.md +++ b/cips/cip-1.md @@ -274,6 +274,7 @@ the following parts: and semantics of any new feature. The specification should be detailed enough to enable competing, interoperable implementations for any of the current Celestia platforms. +* **Parameters**: Summary of any parameters introduced by or changed by the CIP. * **Rationale**: The rationale elaborates on the specification by explaining the reasoning behind the design and the choices made during the design process. It should discuss alternative designs that were considered and any related work. From ccce1dc02b5ae21071b213e3e46a1fe3e4d26b47 Mon Sep 17 00:00:00 2001 From: Ethan Buchman Date: Wed, 6 Mar 2024 19:49:42 -0500 Subject: [PATCH 3/6] Update cip-template.md --- cips/cip-template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cips/cip-template.md b/cips/cip-template.md index b604b15..860a792 100644 --- a/cips/cip-template.md +++ b/cips/cip-template.md @@ -44,7 +44,7 @@ The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "S ## Parameters -The parameters section should summarize any changes to global parameters, including any new parameters. All mainnet parameters are tracked in [CIP-13](./cip-13.md). Once a CIP is accepted and deployed to mainnet, CIP-13 MUST be updated with these parameter changes. If there are no parameter changes in the CIP, this section can be omitted. +The parameters section should summarize any changes to global or module parameters, including any new parameters, introduced by the CIP. All mainnet parameters are tracked in [CIP-13](./cip-13.md). Once a CIP is accepted and deployed to mainnet, CIP-13 MUST be updated with these parameter changes. If there are no parameter changes in the CIP, this section can be omitted. **TODO: Remove the previous comments and update the following table before submitting** From 4343efed0fd60a3d39d316a05d3a3329afeb9e83 Mon Sep 17 00:00:00 2001 From: Josh Stein <46639943+jcstein@users.noreply.github.com> Date: Thu, 14 Mar 2024 14:41:26 -0400 Subject: [PATCH 4/6] Update cips/cip-template.md Co-authored-by: Rootul P --- cips/cip-template.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/cips/cip-template.md b/cips/cip-template.md index 860a792..74f33aa 100644 --- a/cips/cip-template.md +++ b/cips/cip-template.md @@ -53,7 +53,14 @@ The parameters section should summarize any changes to global or module paramete | module1.Name1 | Value1 | Description1 | bool | | module2.Name2 | Value2 | Description2 | bool | - +For changes to existing parameters, use the following table: + +| Parameter | Current value | Proposed value | Description | Changeable via Governance | +|---------------|---------------|----------------|--------------|---------------------------| +| module1.Name1 | CurrentValue1 | ProposedValue1 | Description1 | bool | +| module2.Name1 | CurrentValue2 | ProposedValue2 | Description2 | bool | + +For new parameters the Current value column can be omitted. ## Rationale The rationale fleshes out the specification by describing what motivated the design and why particular design decisions were made. It should describe alternate designs that were considered and related work, e.g. how the feature is supported in other languages. From 33250f1ee8ea3fc076824bd590a9a9fd67b09879 Mon Sep 17 00:00:00 2001 From: Josh Stein <46639943+jcstein@users.noreply.github.com> Date: Thu, 14 Mar 2024 15:04:06 -0400 Subject: [PATCH 5/6] Apply suggestions from code review --- cips/cip-template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cips/cip-template.md b/cips/cip-template.md index 74f33aa..fe06c4b 100644 --- a/cips/cip-template.md +++ b/cips/cip-template.md @@ -48,7 +48,7 @@ The parameters section should summarize any changes to global or module paramete **TODO: Remove the previous comments and update the following table before submitting** -| Parameter | Default | Summary | Changeable via Governance | +| Parameter | Proposed value | Description | Changeable via Governance | |---------------|---------|------------------------------------------------------------------------------------------------------------------------|---------------------------| | module1.Name1 | Value1 | Description1 | bool | | module2.Name2 | Value2 | Description2 | bool | From 63b681c74aaa896b45ec4bad987ddcc78f567bbe Mon Sep 17 00:00:00 2001 From: Josh Stein <46639943+jcstein@users.noreply.github.com> Date: Thu, 14 Mar 2024 15:04:43 -0400 Subject: [PATCH 6/6] Apply suggestions from code review --- cips/cip-template.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/cips/cip-template.md b/cips/cip-template.md index fe06c4b..c8670e7 100644 --- a/cips/cip-template.md +++ b/cips/cip-template.md @@ -50,8 +50,8 @@ The parameters section should summarize any changes to global or module paramete | Parameter | Proposed value | Description | Changeable via Governance | |---------------|---------|------------------------------------------------------------------------------------------------------------------------|---------------------------| -| module1.Name1 | Value1 | Description1 | bool | -| module2.Name2 | Value2 | Description2 | bool | +| module1.Name1 | ProposedValue1 | Description1 | bool | +| module2.Name2 | ProposedValue2 | Description2 | bool | For changes to existing parameters, use the following table: @@ -61,6 +61,7 @@ For changes to existing parameters, use the following table: | module2.Name1 | CurrentValue2 | ProposedValue2 | Description2 | bool | For new parameters the Current value column can be omitted. + ## Rationale The rationale fleshes out the specification by describing what motivated the design and why particular design decisions were made. It should describe alternate designs that were considered and related work, e.g. how the feature is supported in other languages.