https://github.com/ocaml/RFCs
Design discussions about the OCaml language
https://github.com/ocaml/RFCs
Last synced: 2 months ago
JSON representation
Design discussions about the OCaml language
- Host: GitHub
- URL: https://github.com/ocaml/RFCs
- Owner: ocaml
- Created: 2019-10-07T09:04:15.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-10-01T19:19:31.000Z (10 months ago)
- Last Synced: 2024-11-05T09:50:05.535Z (8 months ago)
- Size: 378 KB
- Stars: 148
- Watchers: 95
- Forks: 32
- Open Issues: 25
-
Metadata Files:
- Readme: Readme.md
Awesome Lists containing this project
- awesome-list - RFCs
- awesome-standards - OCaml RFCs - Design discussions about the OCaml language. (Programming Languages)
README
# OCaml RFCs
This repository is for proposals to change the OCaml language
or the internals of its compiler.
**It is for proposals by people who actually intend to implement the
proposed changes. Feature requests from users of the language should
instead by made as issues on [ocaml/ocaml](https://github.com/ocaml/ocaml/issues)**.
## Making an RFC
RFCs are made by creating a pull request that adds a file to the
`rfcs` folder. The `rfcs` folder contains accepted proposals for
changes to the language. The pull request will only be merged
once there is consensus to accept the change in principle.
We'll adjust and adapt the process as we go, but as a starting point
RFCs should provide:
- A high-level summary of the change
- Motivation for the change
- Technical details of the change
- Drawbacks of the change and alternatives to the change
- Unresolved questions
## Discussing an RFC
RFCs will be discussed in the comments of the pull request that
proposes them. Authors should try to respond to queries and integrate
feedback into the RFC document. Commenters should try to avoid
unnecessary bike-shedding.
The OCaml development team will moderate these discussions. We may
delete comments or close pull requests that we feel are not
productive.
## Reaching a decision
## Merging an RFC
If debate on the RFC converges on clear consensus, the RFC can be
merged.
If a consensus of OCaml maintainers is elusive (including perhaps the
case where an RFC does not attract enough attention), you can request
review from the [OCaml Language Committee](Committee.md). The linked
page describes the committee workings; if you want its attention, you
should tag its chair, currently @Octachron. The committee will then
make a recommendation about inclusion of this feature in the language,
though it has no formal power to make a final decision. At that point,
it can either be merged (if there is clear willingness to do so) or
sent to the next developers' meeting.
Regardless of whether the committee has driven the decision or the
discussion at the developers' meeting has, a decision will be to either:
- Accept the proposal and merge the RFC
- Reject the proposal and close the RFC
- Request further changes/discussion on the RFC before reconsidering
at another meeting.
Once an RFC has been accepted into the repository authors can begin
implementing the proposal and be reasonably confident that a suitable
implementation of the feature will be accepted upstream into the
compiler.