Skip to content

Commit 0adc107

Browse files
authored
Clarify comment in RFC Template (#3462)
Looking at the RFC template file, I thought that the recommendation to leave the software design section empty referred to everything below the comment, rather than just that section. This PR updates the comment. By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 and MIT licenses.
1 parent d5c1b71 commit 0adc107

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

rfc/src/template.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,8 @@ No further explanation is needed.
4343

4444
## Software Design
4545

46+
**We recommend that you leave the Software Design section empty for the first version of your RFC**.
47+
4648
This is the beginning of the technical portion of the RFC.
4749
From now on, your main audience is Kani developers, so it's OK to assume readers know Kani architecture.
4850

@@ -53,8 +55,6 @@ Please provide a high level description your design.
5355
- Any changes to how these components communicate?
5456
- What corner cases do you anticipate?
5557

56-
**We recommend you to leave this empty for the first version of your RFC**.
57-
5858
## Rationale and alternatives
5959

6060
This is the section where you discuss the decisions you made.

0 commit comments

Comments
 (0)