RFCs are a process of documenting proposal for technical change. It help to structure project architecture around collective discussions with your community.
This repository is a github template that will help you easily bootstrap your RFC book. You can view the demo at https://plab-io.github.io/project-rfcs-template/.
- RFCs book setup using mdbook
- RFC template at
src/0000-rfc-template.mdwith example atsrc/rfcs/0000-awesome-rfc-template.md - RFC guide at
src/rfcs/rfcs.md - Code Of Conduct form https://opensource.guide/code-of-conduct/
- Contributor page
- Github workflow to publish mdBook on github-pages
- Use this repo as a template
- Use bootstrap script replace the template variables
❯ ./bin/bootstrap.sh
Github Organization Name:
PLAB-IO
Repository Name:
project-rfcs-template
Contact in case of abuse report:
[email protected]
Did you want remove rfc example?: [yes/no]
yes
rm 'src/rfcs/0000-awesome-rfc-template.md'- Following the guide instruction of section
How to propose a new RFC
If you have any question, recommendation, or improvement. Or even if you use this class and it's useful for you, thanks for taking a few minutes to open an issue and share your experience.
- Fork 📖
- Push 🏃
- PR 👏