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 RFC protocol readme #5

Open
madolson opened this issue Jul 29, 2024 · 2 comments
Open

Update RFC protocol readme #5

madolson opened this issue Jul 29, 2024 · 2 comments

Comments

@madolson
Copy link
Member

madolson commented Jul 29, 2024

Based on a core team discussion, we want to update the RFC workflow to looking something like:

  1. RFC is opened by the author, it’s set initially to proposed. (TBD, explain it more clearly that proposed is the default state). An initial label of "draft" will be attached.
  2. A TSC member will review it for style so that it conforms to the RFC style guide.
  3. Once style is correct, we will set a period of time for open-discussion and we will attach a label: "ready-for-discussion"
  4. At the end of the open-discussion, we will set a date to review it synchronously during a core team meeting.
  5. After it’s been reviewed. We will merge the RFC. If we approved of the RFC, we will merge it as is, otherwise we will add open questions and leave it in proposal for the author to do it offline.
  6. If the RFC was not initially approved, the author will be able to update the document offline and it will either by moved to approved offline or they can request another meeting to review it again.
@hpatro
Copy link
Contributor

hpatro commented Aug 9, 2024

A TSC member will review it for style so that it conforms to the RFC style guide.

I'm unsure what style means here, if it means covering all the required section. I would suggest providing a reference or template to the community to cover all possible cases which might be important for maintainers to have clarity on.

Created a reference PR: #6

@madolson
Copy link
Member Author

I'm unsure what style means here, if it means covering all the required section. I would suggest providing a reference or template to the community to cover all possible cases which might be important for maintainers to have clarity on.

I originally imagined it would be covered README: https://github.com/valkey-io/valkey-rfc/, but a template is not a bad idea either. Reading through your template, it covers a lot of great points.

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

2 participants