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

Change top-level README to use dynamically generated lists #887

Merged

Conversation

rphair
Copy link
Collaborator

@rphair rphair commented Aug 24, 2024

Last step in implementing #883.

Before reviewing, please read (and perhaps comment on) description of the PR state tagging vocabulary that was applied through the whole PR queue this week: https://github.com/cardano-foundation/CIPs/wiki/301.-State-tagging

1 - The lists of candidate CIPs and CPSs can no longer be sorted by the candidate CIP number as they were in the manually generated tables. Interestingly, GitHub cannot do this. This is a toss-up: maybe before it was easier to find a particular proposal & now it's easiest to find the oldest or newest proposals (plus the user can change to a different sort ordering if they want, add more search terms, etc.).

2 - If any wrong items show up on these dynamically generated lists, it means somehow a preposterous set of tags has been applied. Some care is applied to the queries to prevent this in many cases (i.e. filtering out any "administrative" tagged proposals, even though they generally are not supposed to have a "state" in the review process).

3 - The deleted lists had many likely-abandoned proposals even after I made regular cullings of closed proposals. The list of "actively reviewed" CIP/CPS PRs is actually quite small & manageable. Likewise the total PR queue will be rather small once the "Stalled" proposals are either closed or the current & ongoing attention causes the authors to revive and progress them (I will be happy either way).


(updated README rendered in branch: changes begin here)

@rphair rphair added the Bi-Weekly Notes / Editorial Housekeeping Publishing Bi-weekly meetings minutes / Mintor edits of public surrounding information label Aug 24, 2024
README.md Show resolved Hide resolved
Copy link
Collaborator

@Ryun1 Ryun1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this a awesome change
Providing more clarity to proposers AND reducing editor overhead 🤝

description of the PR state tagging vocabulary that was applied through the whole PR queue this week: https://github.com/cardano-foundation/CIPs/wiki/301.-State-tagging

This is pretty damn good, I have very little to be able to add on this

The lists of candidate CIPs and CPSs can no longer be sorted by the candidate CIP number as they were in the manually generated tables

I feel like this is fine, considering the benefits that using these state labels brings

Copy link
Collaborator

@Crypto2099 Crypto2099 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very good idea!

@rphair
Copy link
Collaborator Author

rphair commented Aug 26, 2024

@Ryun1 @Crypto2099 @KtorZ one last idea (for a future PR, since we should agree on the language how it's presented): I believe it would help to have a link to the Update proposals before the "Stalled" section, since people who follow the body of CIPs would be interested in following that. ... p.s. done in #891

@rphair rphair merged commit 8fdf00e into cardano-foundation:master Aug 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bi-Weekly Notes / Editorial Housekeeping Publishing Bi-weekly meetings minutes / Mintor edits of public surrounding information
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants