Merge pull request #549 from damirka/leo-rfc

[RFC] Leo RFC proposal
This commit is contained in:
Alessandro Coglio 2021-05-02 14:00:56 -07:00 committed by GitHub
commit f5ad06cf59
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 68 additions and 0 deletions

View File

@ -0,0 +1,44 @@
# Summary
This is an RFC to propose RFC format for Leo language.
# Motivation
Leo develops rapidly and changes to the language need to be stated clearly and presented to everyone. RFC is the perfect tool for turning chaos into order.
# Design
This section describes proposed solution.
## Store RFCs inside Leo repository.
At early stages it is for better to see changes with the code eliminating the need to keep track of a different repository.
## Use standard PR mechanics for submitting new RFCs
New RFCs should be submitted as a PRs into Leo repository. PRs should be correctly labeled for easier search. Yet they should not have number unless PR is accepted by leo maintainers.
## Increase approvals count for RFCs
RFCs may propose changes affecting multiple systems or projects. They also introduce new changes to the language design or structure. Because of that they should be watched more carefully by as many involved team members as possible. Increasing number of required approvals should help achieve this goal.
## Format
For bootstrapping new requests template is made and placed into RFC folder.
## Number
RFCs should receive number once they are accepted.
# Drawbacks
None.
# Effect on Ecosystem
None.
# Alternatives
Propose language changes in team channels or as GitHub issues.

24
docs/rfc/__template.md Normal file
View File

@ -0,0 +1,24 @@
# Summary
What is the proposal?
# Motivation
What problems does it solve? What is the background?
# Design
What are the details of proposal?
# Drawbacks
What problems does this solution bring in?
# Effect on Ecosystem
How changes affect other projects and language ecosystem in general?
# Alternatives
What are the alternatives?