mirror of
https://github.com/ProvableHQ/leo.git
synced 2024-12-23 02:01:54 +03:00
initial commit for RFCs
This commit is contained in:
parent
1a36a262b8
commit
df8bcb556c
44
docs/rfc/000-rfc-format.md
Normal file
44
docs/rfc/000-rfc-format.md
Normal 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
24
docs/rfc/__template.md
Normal 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?
|
||||
|
Loading…
Reference in New Issue
Block a user