Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 8 additions & 34 deletions Readme.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,16 @@
# OCaml RFCs, notes and paper drafts
# OCaml RFCs

This repository is for work collaborating on the OCaml
type-checker. It is split into four folders:
This repository is for proposals to change the OCaml language
or the internals of its compiler. It currently has a single folder:

- rfcs
- designs
- research
- notes
- rfcs

## RFCs

The rfcs folder is for accepted proposals for changes to the language
or (existing) type-checker. Files should be created in this directory
via pull requests, and the merging of those pull requests should only
happen once there is consensus to accept the change in principle.
The rfcs folder is for accepted proposals for changes to the
language. Files should be created in this directory via pull requests,
and the merging of those pull requests should only happen 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:
Expand All @@ -27,26 +24,3 @@ RFCs should provide:
Then we can discuss the proposal in the comments of the pull request
and, once consensus is reached, either merge or close the pull
request.

## Designs

The designs folder is intended for design documents related to the
"high road" type-checker. Such documents can be added and evolved via
pull request to enable people to easily collaborate and discuss these
designs.

Merging a document to this directory has no particular meaning so
people can make up their own minds about when to merge such pull
requests.

## Research

The research folder is for draft papers and other research materials
(e.g. formalisations) related to the "high road" type-checker. As with
the designs directory, the aim of this folder is to aid collaboration
and people should feel free to use the folder as they see fit.

## Notes

The notes folder is for meeting minutes, reports, and other
administrative notes related to working on the type-checker.
3 changes: 0 additions & 3 deletions designs/Readme.md

This file was deleted.

4 changes: 0 additions & 4 deletions notes/Readme.md

This file was deleted.

4 changes: 0 additions & 4 deletions research/Readme.md

This file was deleted.

2 changes: 1 addition & 1 deletion rfcs/Readme.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# RFCs

This directory is for accepted proposals related to the type-checker
This directory is for accepted proposals
Loading