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 process workflow #39

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

update RFC process workflow #39

wants to merge 2 commits into from

Conversation

barriebyron
Copy link
Contributor

I like the way @garwalsh articulates

our commitment to RFCs as the genesis of work hitting the board.

As we lean in to keeping the RFC workflow in focus, this PR updates the process for updates

The README is the welcome sign of the RFC process, so hopefully, this update captures the intention and our commitment to leveraging RFCs for work and historical purposes.

Please suggest changes as needed

@barriebyron
Copy link
Contributor Author

@bkase @nholland94 @mrmr1993 what do you think?

README.md Outdated
2. An internal O(1) Labs team member creates a pull request using the [0000-template.md](0001-template.md).
3. The RFC describes changes in enough detail to inform the decision. This includes links to proposed changes to persistent or cannonical design records such as specs and code comments.
2. An internal O(1) Labs team member creates the RFC pull request using the [0000-template.md](0001-template.md).
3. The RFC submitter describe changes in enough detail to inform the decision. Be sure to include links to proposed changes to persistent or cannonical design records such as specs and code comments.
Copy link
Member

Choose a reason for hiding this comment

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

The tense here seems wrong, shouldn't this still be describes?


## Qualities of effective RFCs

- Prefer timely over perfect
- Enable collaborative code comments, questions, and responses that capture the relevant RFC discussion
- Provide context for changes that impact different product areas
- Currency
Copy link
Member

Choose a reason for hiding this comment

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

It's not clear to me what this means. Can you say more, or remove it?

README.md Outdated
2. An internal O(1) Labs team member creates a pull request using the [0000-template.md](0001-template.md).
3. The RFC describes changes in enough detail to inform the decision. This includes links to proposed changes to persistent or cannonical design records such as specs and code comments.
2. An internal O(1) Labs team member creates the RFC pull request using the [0000-template.md](0001-template.md).
3. The RFC submitter describe changes in enough detail to inform the decision. Be sure to include links to proposed changes to persistent or cannonical design records such as specs and code comments.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Suggested change
3. The RFC submitter describe changes in enough detail to inform the decision. Be sure to include links to proposed changes to persistent or cannonical design records such as specs and code comments.
3. The RFC submitter describes changes in enough detail to inform the decision. Be sure to include links to proposed changes to persistent or canonical design records, such as specs and code comments.


## Qualities of effective RFCs

- Prefer timely over perfect
- Enable collaborative code comments, questions, and responses that capture the relevant RFC discussion
- Provide context for changes that impact different product areas
- Currency
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Suggested change
- Currency
- Currency: RFC document is up-to-date with current product versions

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@mrmr1993 this point is to list up-to-date content as a desirable feature of an effective RFC

imo, this currency quality is implied, but we do have several open RFCs that might no longer be accurate for the current releases

@barriebyron barriebyron requested a review from mrmr1993 November 27, 2023 13:33
README.md Outdated Show resolved Hide resolved
@barriebyron
Copy link
Contributor Author

@bkase did you want to merge these minor updates? or?

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

Successfully merging this pull request may close these issues.

3 participants