You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
-39Lines changed: 0 additions & 39 deletions
Original file line number
Diff line number
Diff line change
@@ -24,7 +24,6 @@ We've provided a list of community-driven content below. When adding content to
24
24
-[Success Stories](#content-success-story)
25
25
-[Academic and Industrial Users](#content-user)
26
26
-[OCaml Books](#content-book)
27
-
-[OCaml Cookbook Recipes](#content-cookbook)
28
27
-[Recurring Events](#content-recurring-event)
29
28
-[Upcoming Events](#content-upcoming_event)
30
29
-[The OCaml Changelog](#content-changelog)
@@ -118,44 +117,6 @@ You can add a new academic user by creating a new Markdown file in [data/academi
118
117
119
118
Add a new OCaml book by creating a new Markdown file in [data/books/](data/books/). For instance: [ocaml-from-the-very-beginning.md](data/books/ocaml-from-the-very-beginning.md).
120
119
121
-
### <aname="content-cookbook"></a>Add a Recipe to the OCaml Cookbook
122
-
123
-
The OCaml Cookbook is a place where OCaml developers share how to solve common
124
-
tasks in OCaml using packages from the OCaml ecosystem.
125
-
126
-
Here are the steps to contribute a recipe for an existing task:
127
-
* Find the task in the [data/cookbook/tasks.yml](data/cookbook/tasks.yml) file.
128
-
* Go to the task folder inside [data/cookbook/](data/cookbook/) that has the
129
-
same name as the task's `slug`.
130
-
* Create a `.ml` file containing the recipe and a YAML header with metadata about
131
-
the recipe.
132
-
133
-
If the recipe does not fit into any existing task, you also need to create a
134
-
task. Add a `task:` entry in [data/cookbook/tasks.yml](data/cookbook/tasks.yml)
135
-
file. Fields `title`, `description`, and `slug` are mandatory. The task must be
136
-
located under a relevant `category:` field.
137
-
138
-
Finally, it is also possible to create and organise groups of tasks by creating
139
-
new categories. Categories are recursive and may have subcategories, which are
140
-
full categories too. A task listed in
141
-
[data/cookbook/tasks.yml](data/cookbook/tasks.yml) may have no recipes yet. On the
142
-
other hand, it is not allowed to have a task folder in
143
-
[data/cookbook/](data/cookbook/) that does not correspond to a task from the
144
-
[data/cookbook/tasks.yml](data/cookbook/tasks.yml) file because it triggers a
145
-
compilation error.
146
-
147
-
Each recipe is a way to perform a task using a combination of open-source
148
-
libraries.
149
-
150
-
#### OCaml Cookbook Recipe Review Checklist
151
-
152
-
Checklist for reviewing OCaml cookbook submissions:
153
-
154
-
1. does this recipe implement the task it's assigned to?
155
-
2. if this recipe is creating a new task: (1) is the new task substantially different from existing tasks, (2) there is no existing task that this recipe solves, (3) is the new task description very clear on what the task is (be specific!)
156
-
3. is the code explained sufficiently without overexplaining (be short and focus on what matters)?
157
-
4. is the code such that you would put it into production? I.e. are the libraries used stable enough and is the code readable?
158
-
159
120
### <aname="content-recurring-event"></a>Add A Recurring Event
160
121
161
122
> Contribute a [Recurring Event](https://ocaml.org/community).
0 commit comments