Additional sections to CIP template #33
Replies: 3 comments 2 replies
-
@maebeam This still needs a CIP since we are changing the CIP process, but would you be okay if we add the last 3 sections?
If you are curious to see how the template change PR would look like, here it is: Thanks |
Beta Was this translation helpful? Give feedback.
-
I am happy with these additions to the template - makes sense. |
Beta Was this translation helpful? Give feedback.
-
I'm happy with these additions. Data Storage Change feels like it should be covered in Specification though and doesn't need its own section |
Beta Was this translation helpful? Give feedback.
-
Can we add three more sections to the template?
Alternate designs - Gives the community idea on why some design choices were skipped.
Data storage change - As more fields are added, we need to start ensuring these new fields don't increase gas fees so much (as well as making nodes disk heavy).
Acknowledgements - People often have others who contributed, but not authors. This is a better place to ensure proper crediting?
For a preview on how the CIP will look like, here is the preview. These 3 sections will be added at the end below Security Considerations.
cip:
title:
author: <a list of the author's or authors' name(s) and/or username(s), or name(s) and email(s), e.g. (use with the parentheses or triangular brackets): FirstName LastName (@githubusername), FirstName LastName [email protected], FirstName (@githubusername) and GitHubUsername (@githubusername)>
discussions-url:
created: <date created on, in ISO 8601 (yyyy-mm-dd) format>
This is the suggested template for new CIPs. Note that a CIP number will be assigned by a core dev.
One-Line Description
A very simple description that someone who's quickly scanning CIPs can use to
immediately understand what this change is doing.
Explanation and Motivation
Provide a simple explanation of the CIP.
Include an explanation of the "why" behind this CIP. What problem does it solve?
Specification
The technical specification should describe the new feature in deep technical detail. It should be detailed enough to allow for complete implementation.
Include the rationale behind any decisions. If there were any approaches that didn't work, feel free to explain them to help future devs understand why things are the way they are.
Backwards Compatibility
All CIPs that introduce backwards incompatibilities must include a section describing these incompatibilities and their severity. The CIP must explain how the author proposes to deal with these incompatibilities.
Test Cases
If this change requires more than just unit tests, include an explanation of how you're going to test your change to make sure it works.
Security Considerations
All CIPs must contain a section that discusses the security
implications/considerations relevant to the proposed change. Include
possible attack vectors or ways this change could cause problems
down the road.
Alternate designs considered
Provide a list of other ideas that you considered and their pros and cons.
This will help community understand the constraints under which other ideas were
not chosen.
Data Storage Change
Identify the additional storage requirement in the blockchain due to this change.
Acknowledgements
If there were additional community members that helped you guide / hone your
thoughts, or members whose feedback was constructive to make this CIP better.
Beta Was this translation helpful? Give feedback.
All reactions