-
Notifications
You must be signed in to change notification settings - Fork 912
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fix CIP information generation by removing "type" property. #1135
Fix CIP information generation by removing "type" property. #1135
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Another option would be to use:
Category
if it's defined in the header, orType
if not (i.e. the legacy CIP definition).
All CIPs originally had Type
but then, following the updated CIP-0001
, specified a Category
instead. All CIPs had either one or the other as a requirement for being merged. Old CIPs that we've updated or will update soon (cardano-foundation/CIPs#389) will have Type
removed and a Category
assigned.
The old language that worked for Type
would actually work well for Category
preceding the name of the CIP: since the Category is also a modifier (Ledger CIP, Plutus CIP, etc.): https://github.com/cardano-foundation/CIPs/tree/master/CIP-0001#categories
After cardano-foundation/CIPs#389 is complete, all CIPs will have only a Category
field and none of them will have a Type
field.
Just having a look at this again & think these other refinements would be easy to make if fully updating this code for the new CIP-0001 specification:
|
sounds like a good idea, let me update you here when I push a commit with the following changes. |
Any updates on this? We seem not to move here. |
Checklist
yarn build
after adding my changes without getting any errors.Updating documentation or Bugfix
Since according to CIP-0001,
type
property in header was quote:"confusing and not-too-useful" I don't believe we should use it in CIP information at the end of each CIP generated on Developer Portal. In the example bellow CIP-0002 doesn't havetype
property so its displayingnull
.Currently on Master it looks like this:
I suggest we make it look like this: