-
Notifications
You must be signed in to change notification settings - Fork 1.8k
chore: Add RFC process #1961
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
chore: Add RFC process #1961
Conversation
Signed-off-by: binarylogic <[email protected]>
Signed-off-by: binarylogic <[email protected]>
Signed-off-by: binarylogic <[email protected]>
If we're going to add RFCs as markdown docs, how about we also add https://github.com/DavidAnson/markdownlint? Not necessarily in this PR, but if we're going to work with markdown files even more - I think it makes a lot of sense. It supports nice things, like editor integration and autoformatting! |
|
||
1. Search Github for previous issues and RFCs on this topic. | ||
2. Open an issue representing the change for light discussion. | ||
3. In the isuee, obtain consensus that a RFC is necessary. |
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.
Is isuee
a typo?
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.
Yes, it’s my damn Apple keyboard. I’ll fix it.
So, a follow up from the sync up. What if we put this in a separate repo? This should do a better job in isolating the RFC editing process from the code editing process. What are the benefits of having rfcs dir in the vector repo? I think there are inly the minor ones, like the usual “you have to clone just a single repo“. However, to work on an RFC one would have to always work on a dedicated branch of |
I am 👍 on a separate repo for rfcs. |
A few arguments for keeping RFCs inside the main Vector's repo:
|
Note that instead of
|
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 see an Alternatives
section in the template, but otherwise this looks good to me.
To me personally, I only see the last one as really beneficial. If we plan to link RFC on the website - we'll have an easier life if it's in the website repo - that currently being the vector repo. However, we might want to move it out as well (only leaving the docs in the vector repo, since they and the code have a shared lifecycle). If we have two repos, people will be able to watch just one of them - for example, somebody might be interested only in the RFCs. So, in regards to repo watching, there are two sides to the coin. |
Signed-off-by: binarylogic <[email protected]>
Problem
Something that has been bothering me lately is our RFC process. Up until recently (~3 months ago) changes have been mostly isolated and green-field. Discussions were less necessary and simple specifications within issues were sufficient. This was on purpose, as we should strive to reduce the process as much as possible.
Lately, though, changes have required more discussion due to:
Solution
I'd like to formalize our RFC process. I use "formalize" loosely. It is a step up from our current process but I do not intend it to be nearly as formal as real RFCs. The amount of time and effort involved in a RFC should scale with the change. You can see what I'm talking about in the new
/rfcs
folder:I'd like to get consensus from everyone on this change before it is implemented.