feat: introducing the RFC process #7
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This adds a first go at an RFC process for Open Job Description. The goal is to have a process defined with the expectation that we will iterate on it as we learn from it. Signed-off-by: Daniel Neilson <53624638+ddneilson@users.noreply.github.com>
mwiebe
reviewed
Dec 20, 2023
shidarin
previously approved these changes
Dec 21, 2023
.github/ISSUE_TEMPLATE/rfc.md
Outdated
| * **Pull Request**: (Add the URL to the pull request here.) | ||
| * **Discussion Thread(s)**: | ||
| * (If there are discussion forum threads where this RFC has been discussed, then | ||
| add URLs to those here. Otherwise, remove this bullet point.) |
rfcs/0000-template.md
Outdated
| your feature would enable for users. How common are those use cases: Are they specific | ||
| to one company's way of working, or more generally adopted? | ||
|
|
||
| Avoid rationales like "this is available like this in system X" since that rationale may not |
There was a problem hiding this comment.
Potentially patronizing. Recommend removing the first 2 sentences and keep the rest- it conveys the message fine.
There was a problem hiding this comment.
Fair. I'll modify this paragraph.
rfcs/0000-template.md
Outdated
|
|
||
| What are the specific changes that are being proposed? | ||
|
|
||
| Write this in a form similar to the official formal specification documents as though |
rfcs/README.md
Outdated
|
|
||
| RFCs can be created by anyone in the community. If you have an idea, a kernel of an idea, or a | ||
| problem to solve, and you think that an addition or a modification of the Open Job Description | ||
| specification is the way to go then we encourage you to engage in this process. |
There was a problem hiding this comment.
remove ", and you think... is the way to go"
They think it's the way to go, or else they wouldn't be here :)
rfcs/README.md
Outdated
|
|
||
| Before you start along the path of proposing your idea as an RFC, please take some time | ||
| to search through our [issues tracker] and [discussion forum] for similar or compatible | ||
| proposals. It is possible that your idea has previously been proposed or that it might fit |
rfcs/README.md
Outdated
|
|
||
| ### 2. Post in GitHub Discussions | ||
|
|
||
| As an informal starting point, we suggest that you use our discussion forums to have |
rfcs/README.md
Outdated
| the hub for conversations, community signal (+1s) and the issue number is used | ||
| as the unique identifier of this RFC. | ||
|
|
||
| > Before creating a tracking issue, please search for similar or related ideas |
There was a problem hiding this comment.
Do you mean to indent this?
rfcs/README.md
Outdated
|
|
||
| Once you have an initial version of your RFC document (it is completely fine to | ||
| submit an unfinished RFC to get initial feedback), submit it as a pull request | ||
| against this repository and start collecting feedback. |
rfcs/README.md
Outdated
|
|
||
| The team will contact you through your RFCs tracking issue when it is time to include | ||
| the proposal in the current draft specification. When that happens, we ask that you | ||
| prepare pull requests to that modify the draft specification, user documentation, and |
There was a problem hiding this comment.
typo: prepare pull requests to that modify
Signed-off-by: Daniel Neilson <53624638+ddneilson@users.noreply.github.com>
mwiebe
approved these changes
Dec 21, 2023
shidarin
approved these changes
Dec 21, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds a first go at an RFC process for Open Job Description. The goal is to have a process defined with the expectation that we will iterate on it as we learn from it.
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.