Skip to content
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

Update older CIPs for revised CIP-0001 #389

Closed
55 tasks done
KtorZ opened this issue Dec 1, 2022 · 8 comments
Closed
55 tasks done

Update older CIPs for revised CIP-0001 #389

KtorZ opened this issue Dec 1, 2022 · 8 comments

Comments

@KtorZ
Copy link
Member

KtorZ commented Dec 1, 2022

The CIP-0001's rework has been merged. In this rework, we've changed the preamble header structure and renamed some of the sections. Thus, for the sake of consistency, we'll need to update past CIPs to reflect this new structure. This issue is meant to help organizing the work around that. For each CIP, we need to:

  • Convert Authors to an actual bullet-point list (one name per line, starting with -)
  • Remove any field that is no-longer supported (e.g. type)
  • Add a Discussions field with a list (same as authors) of links to past discussions. At the very least, this should contain a link to the original PR (git log comes in handy to figure this out).
  • Add any other new fields specified by CIP-0001 (Category, Implementors...).
  • Some sections have been renamed and need to follow the structure given by the new CIP template. In particular, the path to active needs to divided into two sub-sections. It may very much be the case for older CIPs that the path to active is incomplete; which should be reflected in the new structure (CIPs without implementors or implementation plan shall be explicitly labelled as such).
  • Update the top level README.md if there is a status change for this CIP in the table.

Warning We may introduce categories as we see fit; however, categories that would refer to specific areas of the ecosystem (e.g. Ledger which also applies to RSS proposals) need to be endorsed by the respective teams of maintainers. Until this happens, we should refrain from using these categories and simply use N/A in the meantime.

In terms of process; here below is a list of all (currently) merged CIPs; Each item can be converted into issue and assigned to one person. Thus, if you intend to help, make an issue out of one of the point, assign it to you and make a follow-up PR with the changes. Once all CIPs have been updated, we should be able to repair the website build.

@rphair
Copy link
Collaborator

rphair commented Dec 1, 2022

@KtorZ before we get too far into this list, can we reformat the items in the outline above from e.g. :

Adjust preamble and structure of CIP-0003 to abide by new CIP-0001

to

CIP-0003 | Adjust preamble and structure to abide by new CIP-0001

Otherwise the email notifications for all these new PRs and issues will be hard to tell apart, with the distinguishing element so deep into the title. They'll still collate as currently above but will require a wider screen to view. There could also be some historical benefit to using the same format that we use for all our other issues & PRs... rather than having them all stand out as parts of a once-off editing process.

If you and @crptmppt @SebastienGllmt agree I can easily script that change... as could you, but I'm ready, willing & motivated to do it right now 😎

@KtorZ
Copy link
Member Author

KtorZ commented Dec 2, 2022

Done!

@rphair
Copy link
Collaborator

rphair commented Jan 17, 2023

@KtorZ noting also re: resolution at CIP meeting today that we are currently obligated to mark previously merged RSS Proposed CIPs as Inactive. (There are few enough proposals that this will apply to that it shouldn't have to be added to the checklist in the OP.)

@rphair
Copy link
Collaborator

rphair commented Aug 1, 2023

@Ryun1 @KtorZ with the new versioning clarification proposed in #563 I think we might also have to add version treatment to the outline of things to do here... at the very least, to consider adding it (although this could depend on consensus with authors & other proponents, which might not be possible).

@rphair rphair changed the title CIP-0001 update Update older CIPs for revised CIP-0001 Oct 3, 2023
@rphair
Copy link
Collaborator

rphair commented Oct 3, 2023

@KtorZ @Ryun1 @Crypto2099 my Catalyst Fund 10 project has been approved, with filing PRs for all of these as the Q4 2023 milestone. 😬 I've added it to the CIP meeting agenda today so we can talk about how the editorial process would best proceed for these. 😇

@rphair
Copy link
Collaborator

rphair commented Dec 24, 2023

FYI as of now, I've created issues for all the CIP remediations above & linked each one of the unresolved issues to one of 41 new PRs which we can work on refining, approving & merging some time soon in the New Year. 🎉

rphair added a commit that referenced this issue Jan 4, 2024
* double check CIP-0001 compliance as per #389

* spelled NA instead of standard N/A
@Ryun1
Copy link
Collaborator

Ryun1 commented Jan 7, 2024

Great work on this @rphair 💪

Im sure it will feel very satisfying to press the close issue button 🤠

@rphair
Copy link
Collaborator

rphair commented Jan 7, 2024

Thanks for the great backup & insight... you guys are awesome 🤩

@rphair rphair closed this as completed Jan 7, 2024
rphair added a commit that referenced this issue Jan 23, 2024
* add explicit versioning subsection

* /pulls URI syntax error was also in the CPS template

* Ledger process link didn't reflect CIP-0084 merge

* template: canonical URL for pull requests

Co-authored-by: Ryan Williams <44342099+Ryun1@users.noreply.github.com>

* missing shorthand Markdown link

* fix editing error in last commit

* add license template lines to CIP template

* optional sections, including more flexible yet more specific Versioning

* forgot to include Versioning internal link

* last change forgot placeholder for optional sections

* grammar error: wrong preposition

* Path to Active implementation complete with #389

---------

Co-authored-by: Ryan Williams <44342099+Ryun1@users.noreply.github.com>
@rphair rphair unpinned this issue Jan 27, 2024
rphair added a commit that referenced this issue Jul 23, 2024
)

* status updates missed in Remediation effort #389

* post meeting status changes themselves
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants