-
Notifications
You must be signed in to change notification settings - Fork 97
policy: add initial RFC process #61
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Basically looks good imho!
RFC_PROCESS.md
Outdated
|
||
All comments on a particular RFC should be done directly on the PR: An RFC will not be accepted until relevant reviewers are satisfied with changes. Members of the working groups the RFC falls under hold ultimate authority over whether or not to accept an RFC, if there's ever conflict about it, and may resolve that using their own governance and decision-making rules. | ||
|
||
Side discussion can happen externally, but the relevant channel on the Ayo.js Discord is the preferred place to talk through things outside of PR reviews/comments. Furthermore, any decisions/suggestions that are decided on externally should be recorded in the RFC itself, for record keeping. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Discord
→ official documentation channels
?
RFC_PROCESS.md
Outdated
|
||
The name itself is a reference to the IETF's Request For Comments process, and basically involves a document or series of documents which are drafted, reviewed, and eventually ratified (approved) by the Ayo.js community through discussion among those interested. | ||
|
||
An RFC can extend, modify, or alter any part of the Ayo.js project's code or documents, whether or not they've been previously documented. This includes proposing new features, proposing major breaking changes, changes to the Code of Conduct and other community policies, changes to the governance structure of the project, and anything else that affects a significant part of the community. It can also propose entirely new policies and community agreements. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
code or documents
– I’m not sure, do you have anything specific in mind when you say that? Proposing API changes or sth like that?
(also: mind if I push here with 80 character line wrapping again? I’m sorry if that’s annoying but if nothing else, it’s nicer for many editors + makes pointing to specific parts of the doc easier)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yep. Definitely things like proposing APIs. Or, for example, things like WebWorkers, changes to .mjs handling, etc etc.
RFC_PROCESS.md
Outdated
|
||
## How do I create an RFC? | ||
|
||
* Go to https://github.com/ayojs/ayo |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
i'm against on having rfc's in the main repo, as it's already a collossal monolith. can we maybe move them to a separate repo, like rust does? i think it'd also help separate community rfc's away from the main code repo
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd like to advocate for keeping things in this repo for now, because there's relatively little volume and I think it'd be good to bootstrap an RFC process by putting it front-and-center. I would hate it if it ended up being seen like a dumping ground for unwanted ideas.
RFC_PROCESS.md
Outdated
* Must be in `rfcs`. | ||
* Must be an `.md` file. | ||
* The first line should be `# RFC - <title of RFC>` | ||
* Tag at least one member of any relevant working groups. If you're not sure who would be responsible for reviewing your RFC, let the triage process take care of it for you. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
s/working groups/teams
RFC_PROCESS.md
Outdated
|
||
## How does review work? | ||
|
||
All comments on a particular RFC should be done directly on the PR: An RFC will not be accepted until relevant reviewers are satisfied with changes. Members of the working groups the RFC falls under hold ultimate authority over whether or not to accept an RFC, if there's ever conflict about it, and may resolve that using their own governance and decision-making rules. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
s/working groups/teams
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this sentence is structured in a weird way that makes it hard to read, but i can't put my finger on it??
I've updated things according to comments, and responded to some questions (although GitHub swallowed some of them -- sorry). Let me know if there's anything else! |
I think I'm quite pro moving RFCs into separate repo but equally, being out of sight and out of mind are probably a bigger a problem now. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks really good!
(had one nit for clarity)
RFC_PROCESS.md
Outdated
|
||
* Go to https://github.com/ayojs/ayo | ||
* Create a PR with a new RFC document: | ||
* Must be in `rfcs`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
suggestion for clarity (if my reading is correct?): "Must be in the rfcs
folder."
Checklist
Affected core subsystem(s)
policy
Description
Hey y'all. This is an initial swing at getting an RFC process going for Ayo.js. It's based on WeAllJS's RFC process and I'm hoping that it helps give more structure to community proposals, and helps funnel conversations towards relevant parties. I believe this RFC works well for feature requests for Ayo.js, specially in that it asks requestors to put a bit more effort into providing a rationale for the changes and thinking through various issues before starting implementation. I think it also is particularly critical for policy conversations, and makes it much more clear about where and how those are supposed to happen, as well, again, as the rationale behind them.