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

RFC 5 Easier RFCs #148

Merged
merged 3 commits into from
Jan 24, 2025
Merged

Conversation

tristanls
Copy link
Contributor

This RFC proposes making RFCs easier to author and is an example of an "easier" RFC.

I added all Maintainers as reviewers so you can take an initial look if you have additional comments on the proposal or ideas for improvements.

@tristanls tristanls added rfc:proposal This issue tracks an RFC proposal triaged This issue or pull request was triaged labels Jan 21, 2025
@tristanls tristanls self-assigned this Jan 21, 2025
Copy link
Contributor

@vkakerbeck vkakerbeck 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 is a great idea

Copy link
Contributor

@nielsleadholm nielsleadholm left a comment

Choose a reason for hiding this comment

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

Looks great, definitely support this.

We could also maybe link to some past, sample RFCs as concrete examples, like this one for a simple example, and an older one for the full-fledged template.

@tristanls
Copy link
Contributor Author

Sounds good, @nielsleadholm; I included which RFCs will be examples in the text of the RFC.

@tristanls
Copy link
Contributor Author

Motion for Final Comment Period

I motion for the Final Comment Period with the disposition to merge this RFC.

I interpret @nielsleadholm and @vkakerbeck current PR acceptance as approval.
@codeallthethingz, @scottcanoe, @hlee9212 please indicate your decision on the disposition to merge:

  • approve: via approving this PR or commenting that you approve to merge
  • abstain: by commenting that you abstain
  • other: by commenting

Copy link

@hlee9212 hlee9212 left a comment

Choose a reason for hiding this comment

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

LGTM.

- Start Date: (fill me in with today's date, YYYY-MM-DD)
- RFC PR: (leave this empty, it will be filled in after RFC is merged)

Content here.

Choose a reason for hiding this comment

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

Suggestion: Instead of Content here.:

Describe the problem this RFC addresses and your proposed change. Feel free to include images, diagrams, or examples if they help clarify your points (Optional).


I think the above gives appropriate minimal guidance without becoming as comprehensive as the other template.

Copy link
Contributor

Choose a reason for hiding this comment

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

I'm in agreement on this.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

How about

Describe your proposal. Please feel free to include images, diagrams, or examples if they help explain your points (Optional).

I hesitate to ask to describe the problem bit as there might not be a problem.

Copy link
Contributor

@scottcanoe scottcanoe left a comment

Choose a reason for hiding this comment

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

Glad to see it. I was a bit intimated by RFCs myself, so this clarification is welcome.

Copy link
Contributor

@codeallthethingz codeallthethingz left a comment

Choose a reason for hiding this comment

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

LGTM

@tristanls
Copy link
Contributor Author

This concludes the Final Comment Period, with all maintainers approving to merge. The PR will be merged shortly after the final pre-merge changes.

@tristanls tristanls changed the title rfc: Easier RFCs RFC 5 Easier RFCs Jan 24, 2025
@tristanls tristanls enabled auto-merge (squash) January 24, 2025 15:06
@tristanls tristanls merged commit e4e41d2 into thousandbrainsproject:main Jan 24, 2025
13 checks passed
@tristanls tristanls deleted the easier_rfcs branch January 24, 2025 15:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
rfc:proposal This issue tracks an RFC proposal triaged This issue or pull request was triaged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants