Skip to content

Commit 141b575

Browse files
author
David Arnold
committed
Differentiate RFC templates
1 parent fdc9d5d commit 141b575

File tree

3 files changed

+145
-12
lines changed

3 files changed

+145
-12
lines changed

‎0000-template.md renamed to ‎0000-template-feature.md

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,51 +8,57 @@ shepherd-leader: (name to be appointed by RFC steering committee)
88
related-issues: (will contain links to implementation PRs)
99
---
1010

11+
<!--
12+
If you are proposing a feature to Nix, Nixpkgs, Hydra or any other
13+
software developped by the nix community, this is the template
14+
you want to use.
15+
-->
16+
1117
# Summary
1218
[summary]: #summary
1319

14-
One paragraph explanation of the feature.
20+
<!-- One paragraph explanation of the feature. -->
1521

1622
# Motivation
1723
[motivation]: #motivation
1824

19-
Why are we doing this? What use cases does it support? What is the expected
20-
outcome?
25+
<!-- Why are we doing this? What use cases does it support? What is the expected
26+
outcome? -->
2127

2228
# Detailed design
2329
[design]: #detailed-design
2430

25-
This is the core, normative part of the RFC. Explain the design in enough
31+
<!-- This is the core, normative part of the RFC. Explain the design in enough
2632
detail for somebody familiar with the ecosystem to understand, and implement.
2733
This should get into specifics and corner-cases. Yet, this section should also
28-
be terse, avoiding redundancy even at the cost of clarity.
34+
be terse, avoiding redundancy even at the cost of clarity. -->
2935

3036
# Examples and Interactions
3137
[examples-and-interactions]: #examples-and-interactions
3238

33-
This section illustrates the detailed design. This section should clarify all
39+
<!-- This section illustrates the detailed design. This section should clarify all
3440
confusion the reader has from the previous sections. It is especially important
3541
to counterbalance the desired terseness of the detailed design; if you feel
3642
your detailed design is rudely short, consider making this section longer
37-
instead.
43+
instead. -->
3844

3945
# Drawbacks
4046
[drawbacks]: #drawbacks
4147

42-
Why should we *not* do this?
48+
<!-- Why should we *not* do this? -->
4349

4450
# Alternatives
4551
[alternatives]: #alternatives
4652

47-
What other designs have been considered? What is the impact of not doing this?
53+
<!-- What other designs have been considered? What is the impact of not doing this? -->
4854

4955
# Unresolved questions
5056
[unresolved]: #unresolved-questions
5157

52-
What parts of the design are still TBD or unknowns?
58+
<!-- What parts of the design are still TBD or unknowns? -->
5359

5460
# Future work
5561
[future]: #future-work
5662

57-
What future work, if any, would be implied or impacted by this feature
58-
without being directly part of the work?
63+
<!-- What future work, if any, would be implied or impacted by this feature
64+
without being directly part of the work? -->

‎0000-template-informational.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
information: (fill me in with a unique ident, my_new_fact)
3+
start-date: (fill me in with today's date, YYYY-MM-DD)
4+
author: (name of the main author)
5+
co-authors: (find a buddy later to help out with the RFC)
6+
shepherd-team: (names, to be nominated and accepted by RFC steering committee)
7+
shepherd-leader: (name to be appointed by RFC steering committee)
8+
relates-to:
9+
- [RFC 0000 my_other_information]()
10+
---
11+
12+
<!--
13+
If you are seeking to gather consensus on a fact, or seek general acceptance about
14+
a new information, then use this template.
15+
The fact or information should be sufficiently important to require an RFC process
16+
Some examples are, without being an exhaustive list:
17+
18+
- Start a talk, meetup, or social networking account that will be expected to
19+
officially “represent nix”
20+
- Document design issues, or recording the decision to _not_ act upon something.
21+
- Proposing an experiment.
22+
- Record high-stake proof-generated insight.
23+
-->
24+
25+
# Summary
26+
[summary]: #summary
27+
28+
<!-- One paragraph to resume this document. -->
29+
30+
In order to address "X", I/we propose to "Y".
31+
32+
# My Structure
33+
34+
<!-- This template does not have a recommended structure, please use your best
35+
judgment for your particular case. -->

‎0000-template-process.md

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
---
2+
process: (fill me in with a unique ident, my_new_process)
3+
start-date: (fill me in with today's date, YYYY-MM-DD)
4+
author: (name of the main author)
5+
co-authors: (find a buddy later to help out with the RFC)
6+
shepherd-team: (names, to be nominated and accepted by RFC steering committee)
7+
shepherd-leader: (name to be appointed by RFC steering committee)
8+
modifies:
9+
- [RFC 0000 my_old_process]()
10+
---
11+
12+
<!--
13+
If you are proposing to change a process with regard of how the nix community
14+
conducts, then use this template. Some examples are, without being an exhaustive list:
15+
16+
- Change the RFC process, the organization of the issue tracker or the forum
17+
- Change community workflows or other comunity infrastructure
18+
- Amend the code of conduct and similar high level normative documents
19+
-->
20+
21+
# Summary
22+
[summary]: #summary
23+
24+
<!-- One paragraph to resume this document (motivation and future process). -->
25+
26+
In order to address "X", I/we propose to "Y".
27+
28+
# Classification
29+
[classification]: #classification
30+
31+
<!-- Please check the relevant boxes (typically one) -- or add your own. -->
32+
33+
- [ ] general habits and decision making
34+
- [ ] core technical protocols & processes
35+
- [ ] contributer efficiency support
36+
37+
# Motivation
38+
[motivation]: #motivation
39+
40+
<!-- What's wrong? Please feel encouraged to benchmark us against other
41+
(open source or other) ecosystems. -->
42+
43+
# Current Process
44+
[as-is]: #current-process
45+
46+
<!-- Describe the current process as it is observed out in the wild.
47+
If there has been a previous RFC for this process, please mention it,
48+
but prefer the state of the world "as-is". In a final paragraph, please
49+
describe its shortcomings and how they relate to the motivation.
50+
51+
Make use of BPMN 2.0 notation, if you'd find that useful. -->
52+
53+
# Future Process
54+
[to-be]: #future-process
55+
56+
<!-- Describe the future process how you imagine it to be.
57+
In a final paragraph, please describe how this would satisfy the motivation.
58+
Please be explicit, if it only party addresses the motivation.
59+
60+
Make use of BPMN 2.0 notation, if you'd find that useful. -->
61+
62+
# Roles & Stakeholders
63+
64+
<!-- Describe in abstract terms the roles involved in this process
65+
and how they are affected by this process change. Plotting estimated
66+
/ abstract time requirements of _as-is_ against _to-be_ is a plus.
67+
The idea is to get a better sense of the stakeholders of this process
68+
and their respective interestes and estimate the associated total
69+
costs imposed (mostly in time, can be negative) to the community.-->
70+
71+
# Pros & Cons
72+
[evaluation]: #pros-and-cons
73+
74+
<!-- Within your judgment, prefer bullet points over prose. -->
75+
76+
## Pros
77+
78+
79+
## Cons
80+
81+
82+
# Conclusion
83+
[conclusion]: #conclusion
84+
85+
<!-- In the greater scheme of things, to wat degree does your proposal
86+
satisfy the motivation. Is it meaningful? Is it important? Is it urgent? -->
87+
88+
# Updates
89+
[updates]: #updates
90+
91+
<!-- This space is reserved for linking or in-lining future updates to this
92+
process -->

0 commit comments

Comments
 (0)