[hare] The Hare programming language
git clone https://git.torresjrjr.com/hare.git
Log | Files | Refs | README | LICENSE

commit d3c2429255e99d42bf10b6cf3fe6f6a3c5debdb6
parent 47737790a2337c177ed5c56f65acd19dc84d3bbe
Author: Drew DeVault <sir@cmpwn.com>
Date:   Mon, 30 Oct 2023 10:34:20 +0100

Add docs/rfc-template.txt

Adds an optional structured template to help people write good RFCs.

Adocs/rfc-template.txt | 41+++++++++++++++++++++++++++++++++++++++++
1 file changed, 41 insertions(+), 0 deletions(-)

diff --git a/docs/rfc-template.txt b/docs/rfc-template.txt @@ -0,0 +1,41 @@ + RFC SUMMARY + +Free-form brief summary of the RFC's goals, 1-2 paragraphs in length. + + LANGUAGE IMPLICATIONS + +Enumerate proposed language changes in this section, if any. + +Put "None" here if there are no language implications. + + STANDARD LIBRARY IMPLICATIONS + +Enumerate proposed standard library changes in this section, if any. Focus on +breaking changes to the standard library's API over implementation details, +unless implementation details are particularly important. + +Put "None" here if there are no standard library implications. + + ECOSYSTEM IMPLICATIONS + +Include considerations for the broader Hare ecosystem here, such as a survey +estimating how many third-party codebases will be affected and how difficult it +will be to implement the changes. If necessary, make a plan for alleviating the +impact, such as automated migration tools (e.g. a sed script, or a dedicated +tool for more complex migrations). + +Put "None" here if there are no ecosystem implications (though in this case, why +is there an RFC for it?). + + EXAMPLE CODE + +Include in this section samples of example code as it will appear under this +RFC's proposed changes. This section is mandatory. + + RELATED RFCS + +Include a link to relevant RFCs (such as the prior version) on the hare-rfc +web archives, as well as a brief summary of changes from that version or the +reason why this RFC is relevant. + +Put "None" here if there are no relevant RFCs.