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

CIP-0381 | post-merge update top level README #300

Closed
wants to merge 2 commits into from

Conversation

rphair
Copy link
Collaborator

@rphair rphair commented Jul 15, 2022

post merge #220

(BTW this also shows some removal of extraneous white space in the diff)

@rphair
Copy link
Collaborator Author

rphair commented Jul 15, 2022

@KtorZ @SebastienGllmt - what procedure did you guys work out for editing the top level table, so as not to require an additional PR every time a CIP PR is merged? I can't remember or perhaps never noticed in the first place; though I do remember entries in this table being updated in groups... 🧐

@KtorZ
Copy link
Member

KtorZ commented Jul 16, 2022

what procedure did you guys work out for editing the top level table

I do grep with my eyes. It's cumbersome but relatively effective 😬 ... I typically do this before every bi-weekly to keep the top-level README updated. That usually takes me about 2-3 min and thus so far, I haven't felt the urge to automate this.

@rphair
Copy link
Collaborator Author

rphair commented Jul 20, 2022

@KtorZ @crptmppt @mangelsjover @SebastienGllmt what do you think of this process: immediately before merging each CIP, we make a quick edit to the top level README in the author's branch to update the table entry?

As we talked about here (#216 (comment)) this is something we generally have to be diplomatic about, but shouldn't be a problem in this case because we're not changing the CIP author's documents.

This way, the top level table gets updated immediately, and doesn't get out of date (so doesn't need to be date-stamped) or need visual update passes periodically.

Also there was a merge conflict here yesterday during the meeting from something else updating a nearby entry in the table & so I lost my opportunity to ask someone to review this while we were all together... this would be less likely to happen if the top level README updates were always done immediately.

In any case can someone please approve this now so it can be merged? 🤓

@KtorZ
Copy link
Member

KtorZ commented Aug 2, 2022

@rphair I'll include this one as part of a bigger update.

@KtorZ KtorZ added the State: Likely Deprecated Close if confirmed deprecated (or long waiting). label Aug 2, 2022
@rphair rphair closed this Aug 2, 2022
@rphair rphair removed the State: Likely Deprecated Close if confirmed deprecated (or long waiting). label Aug 2, 2022
@rphair rphair deleted the rphair-promote-cip-0381 branch December 22, 2023 03:38
@rphair rphair added the Bi-Weekly Notes / Editorial Housekeeping Publishing Bi-weekly meetings minutes / Mintor edits of public surrounding information label Aug 7, 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.

2 participants