mirror of
https://github.com/NixOS/rfcs.git
synced 2025-11-08 11:36:12 +01:00
58 lines
1.8 KiB
Markdown
58 lines
1.8 KiB
Markdown
---
|
|
feature: (fill me in with a unique ident, my_awesome_feature)
|
|
start-date: (fill me in with today's date, YYYY-MM-DD)
|
|
author: (name of the main author)
|
|
co-authors: (find a buddy later to help out with the RFC)
|
|
shepherd-team: (names, to be nominated and accepted by RFC steering committee)
|
|
shepherd-leader: (name to be appointed by RFC steering committee)
|
|
related-issues: (will contain links to implementation PRs)
|
|
---
|
|
|
|
# Summary
|
|
[summary]: #summary
|
|
|
|
One paragraph explanation of the feature.
|
|
|
|
# Motivation
|
|
[motivation]: #motivation
|
|
|
|
Why are we doing this? What use cases does it support? What is the expected
|
|
outcome?
|
|
|
|
# Detailed design
|
|
[design]: #detailed-design
|
|
|
|
This is the core, normative part of the RFC. Explain the design in enough
|
|
detail for somebody familiar with the ecosystem to understand, and implement.
|
|
This should get into specifics and corner-cases. Yet, this section should also
|
|
be terse, avoiding redundancy even at the cost of clarity.
|
|
|
|
# Examples and Interactions
|
|
[examples-and-interactions]: #examples-and-interactions
|
|
|
|
This section illustrates the detailed design. This section should clarify all
|
|
confusion the reader has from the previous sections. It is especially important
|
|
to counterbalance the desired terseness of the detailed design; if you feel
|
|
your detailed design is rudely short, consider making this section longer
|
|
instead.
|
|
|
|
# Drawbacks
|
|
[drawbacks]: #drawbacks
|
|
|
|
Why should we *not* do this?
|
|
|
|
# Alternatives
|
|
[alternatives]: #alternatives
|
|
|
|
What other designs have been considered? What is the impact of not doing this?
|
|
|
|
# Unresolved questions
|
|
[unresolved]: #unresolved-questions
|
|
|
|
What parts of the design are still TBD or unknowns?
|
|
|
|
# Future work
|
|
[future]: #future-work
|
|
|
|
What future work, if any, would be implied or impacted by this feature
|
|
without being directly part of the work?
|