From 0adc107628bc225ecd97f4efc092ff4d6918021d Mon Sep 17 00:00:00 2001 From: Carolyn Zech Date: Tue, 27 Aug 2024 11:33:01 -0400 Subject: [PATCH] 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. --- rfc/src/template.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/rfc/src/template.md b/rfc/src/template.md index 2628bed3c54e..e2755e90ea27 100644 --- a/rfc/src/template.md +++ b/rfc/src/template.md @@ -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. @@ -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.