beyond-fs/docs/rfcs/0-example.md

42 lines
1.1 KiB
Markdown
Raw Permalink Normal View History

- Author: (fill me in with `name <mail>`, e.g., Xuanwo <github@xuanwo.io>)
- Start Date: (fill me in with today's date, YYYY-MM-DD)
- RFC PR: [beyondstorage/beyond-fs#0](https://github.com/beyondstorage/beyond-fs/issues/0)
- Tracking Issue: [beyondstorage/beyond-fs#0](https://github.com/beyondstorage/beyond-fs/issues/0)
# RFC-0: <proposal name>
- Updates: (delete this part if not applicable)
- [GSP-20](./20-abc): Deletes something
- Updated By: (delete this part if not applicable)
- [GSP-10](./10-do-be-do-be-do): Adds something
- [GSP-1000](./1000-lalala): Deprecates this RFC
## Background
Explain why we are doing this.
Related issues and early discussions can be linked, but the RFC should try to be self-contained if possible.
## Proposal
<proposal's content>
## Rationale
<proposal's rationale content, other implementations>
Possible content:
- Design Principles
- Drawbacks
- Alternative implementations and comparison
- Possible Q&As
## Compatibility
<proposal's compatibility statement>
## Implementation
Explain what steps should be done to implement this proposal.