Skip to content

Commit

Permalink
Clarify comment in RFC Template (#3462)
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
carolynzech authored Aug 27, 2024
1 parent d5c1b71 commit 0adc107
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions rfc/src/template.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,8 @@ No further explanation is needed.

## Software Design

**We recommend that you leave the Software Design section empty for the first version of your RFC**.

This is the beginning of the technical portion of the RFC.
From now on, your main audience is Kani developers, so it's OK to assume readers know Kani architecture.

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

**We recommend you to leave this empty for the first version of your RFC**.

## Rationale and alternatives

This is the section where you discuss the decisions you made.
Expand Down

0 comments on commit 0adc107

Please sign in to comment.