Skip to content

Commit 0895312

Browse files
committed
Split out the research parts into their own repo
1 parent 7c29c82 commit 0895312

File tree

5 files changed

+9
-46
lines changed

5 files changed

+9
-46
lines changed

Readme.md

Lines changed: 8 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,16 @@
1-
# OCaml RFCs, notes and paper drafts
1+
# OCaml RFCs
22

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

6-
- rfcs
7-
- designs
8-
- research
9-
- notes
6+
- rfcs
107

118
## RFCs
129

13-
The rfcs folder is for accepted proposals for changes to the language
14-
or (existing) type-checker. Files should be created in this directory
15-
via pull requests, and the merging of those pull requests should only
16-
happen once there is consensus to accept the change in principle.
10+
The rfcs folder is for accepted proposals for changes to the
11+
language. Files should be created in this directory via pull requests,
12+
and the merging of those pull requests should only happen once there
13+
is consensus to accept the change in principle.
1714

1815
We'll adjust and adapt the process as we go, but as a starting point
1916
RFCs should provide:
@@ -27,26 +24,3 @@ RFCs should provide:
2724
Then we can discuss the proposal in the comments of the pull request
2825
and, once consensus is reached, either merge or close the pull
2926
request.
30-
31-
## Designs
32-
33-
The designs folder is intended for design documents related to the
34-
"high road" type-checker. Such documents can be added and evolved via
35-
pull request to enable people to easily collaborate and discuss these
36-
designs.
37-
38-
Merging a document to this directory has no particular meaning so
39-
people can make up their own minds about when to merge such pull
40-
requests.
41-
42-
## Research
43-
44-
The research folder is for draft papers and other research materials
45-
(e.g. formalisations) related to the "high road" type-checker. As with
46-
the designs directory, the aim of this folder is to aid collaboration
47-
and people should feel free to use the folder as they see fit.
48-
49-
## Notes
50-
51-
The notes folder is for meeting minutes, reports, and other
52-
administrative notes related to working on the type-checker.

designs/Readme.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

notes/Readme.md

Lines changed: 0 additions & 4 deletions
This file was deleted.

research/Readme.md

Lines changed: 0 additions & 4 deletions
This file was deleted.

rfcs/Readme.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
# RFCs
22

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

0 commit comments

Comments
 (0)