Let's start the RFCs!#1
Conversation
TheElectronWill
force-pushed
the
init-rfc-process
branch
3 times, most recently
from
55c0bd4 to
efb7b26
Compare
TheElectronWill
force-pushed
the
init-rfc-process
branch
from
efb7b26 to
883b8ae
Compare
| ### Draft Phase (optional) | ||
|
|
||
| 1. Author opens a draft PR with the RFC (using the template – see [CONTRIBUTING.md](CONTRIBUTING.md)). | ||
| 1. Early feedback from the community. |
There was a problem hiding this comment.
IMO it's important, and should not be optional as some people can just propose idea and maybe others could get the same (be sure to check if the idea was not already proposed before). Early feedback can also help to steer the idea in the right direction
| Once no major concerns remain, Alumet contributors can approve the PR. | ||
| When everything is clear, a maintainer merges the PR. | ||
|
|
||
| Implementation begins, tracked via linked issues in the appropriate repository. |
There was a problem hiding this comment.
should it be a good idea to always link the RFC (of this repo) in futurs associated PRs (on alumet repo) ?
There was a problem hiding this comment.
I think issues are enough since they're already linked to PRs
|
|
||
| **Discuss Your Idea First**. | ||
|
|
||
| - Discuss IRL, open a [GitHub Discussion](https://github.com/alumet-dev/alumet/discussions) or open an issue to gauge interest and gather early feedback. |
|
|
||
| **Take your time** preparing the document. | ||
| The writing process itself will help you refine your ideas, explore alternative designs, and clarify your communication. | ||
| While you don't need to over-explain basic concepts, the RFC should be clear enough for any experienced contributor to understand. |
There was a problem hiding this comment.
can the schemes be encouraged if necessary?
| Work on your idea, on your own or with others. | ||
| If possible, create a prototype of your solution. | ||
| Since the goal of the RFC is to work on the ideas and design, there is no need for a perfect implementation. | ||
| What you need to develop is a **deep understanding of the subject**. |
There was a problem hiding this comment.
Just to be sure, are you aware that this will be rendered as a single line?
| - Use the title format: `RFC: [Short Descriptive Title]`. | ||
| - Use the PR template | ||
|
|
||
| 2. **Update the RFC number** with the PR number. |
There was a problem hiding this comment.
Do we add a small checklist to ensure that basic steps have been completed?
4 participants
disclosure: Mistral has been used as a redaction assistant (I have used it for exploration and extensively edited its proposals)
Inspirations: Rust RFCs, OpenFGA RFCs, Juan Pablo Buritica's templates.
todo: