Skip to content

Commit a7fb3c0

Browse files
authored
Merge pull request #2 from oudod/template
Add RFC template
2 parents a98b0c5 + 5177fd0 commit a7fb3c0

File tree

1 file changed

+58
-0
lines changed

1 file changed

+58
-0
lines changed

0000-template.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
- Feature Name: (fill me in with a unique ident, my_awesome_feature)
2+
- Start Date: (fill me in with today's date, YYYY-MM-DD)
3+
- RFC PR: (leave this empty)
4+
- Exonum Issue: (leave this empty)
5+
6+
# Summary
7+
[summary]: #summary
8+
9+
One para explanation of the feature.
10+
11+
# Motivation
12+
[motivation]: #motivation
13+
14+
Why are we doing this? What use cases does it support? What is the expected outcome?
15+
16+
# Detailed design
17+
[design]: #detailed-design
18+
19+
This is the bulk of the RFC. Explain the design in enough detail for somebody
20+
familiar with the Exonum architecture to understand, and for somebody familiar
21+
with the programming language to implement. This should get into specifics and
22+
corner-cases, and include examples of how the feature is used.
23+
24+
# How We Teach This
25+
[how-we-teach-this]: #how-we-teach-this
26+
27+
What names and terminology work best for these concepts and why?
28+
How is this idea best presented — as a continuation of existing Exonum concepts,
29+
or as a wholly new one?
30+
31+
Would the acceptance of this proposal change how Exonum is presented to new users
32+
at any level?
33+
How should this feature be introduced and taught to existing Exonum users?
34+
35+
What additions or changes to the [Exonum documentation] does it entail?
36+
37+
What would the outline of a new section in the documentation look like? What
38+
should the reader be able to understand by the end of the section in the
39+
documentation?
40+
41+
What's an example that would show off this feature?
42+
43+
# Drawbacks
44+
[drawbacks]: #drawbacks
45+
46+
Why should we *not* do this?
47+
48+
# Alternatives
49+
[alternatives]: #alternatives
50+
51+
What other designs have been considered? What is the impact of not doing this?
52+
53+
# Unresolved questions
54+
[unresolved]: #unresolved-questions
55+
56+
What parts of the design are still TBD?
57+
58+
[Exonum documentation]: https://github.com/exonum/exonum-doc

0 commit comments

Comments
 (0)