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
+37-5Lines changed: 37 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,19 +18,24 @@ Please include images and browser-specific information if the bug is related to
18
18
19
19
We've provided a list of community-driven content below. When adding content to any of these sections, it's best to fork the repo, add your file, and open a pull request (PR).
20
20
21
+
Anyone can contribute to these sections:
21
22
-[Images](#images)
22
23
-[The OCaml Planet](#ocaml-planet)
23
24
-[Job Board](#content-job)
24
-
-[Success Stories](#content-success-story)
25
25
-[Academic Users](#content-academic-user)
26
26
-[Industrial Users](#content-industrial-user)
27
27
-[OCaml Books](#content-book)
28
28
-[OCaml Cookbook Recipes](#content-cookbook)
29
29
-[Recurring Events](#content-recurring-event)
30
30
-[Upcoming Events](#content-upcoming_event)
31
+
32
+
OCaml Platform maintainers can contribute to these sections:
The [OCaml Changelog](https://ocaml.org/changelog) is a user-oriented blog that serves as a newsfeed for the OCaml ecosystem. It's important to note that despite its name, it's not a traditional changelog, but rather a curated blog of significant updates and news.
229
+
The [OCaml Changelog](https://ocaml.org/changelog) is a user-oriented blog that serves as a newsfeed for the OCaml ecosystem. It's important to note that despite its name, it's not a traditional changelog, but rather a curated blog of significant updates and news about the stable OCaml tooling.
225
230
226
231
The Changelog covers developments across:
227
232
@@ -253,11 +258,38 @@ The Changelog is not meant for:
253
258
To contribute a new post to the Changelog:
254
259
255
260
1. Create a new Markdown file in the `data/changelog/` directory.
256
-
2. Use a clear, descriptive filename (e.g., `2023-06-15-ocaml-5-1-release.md`).
257
-
3. Include relevant metadata at the top of the file (date, title, tags, etc.).
261
+
2. Use a clear, descriptive filename (e.g., `2025-08-26-ocaml-eglot-brings-lsp-support-to-emacs.md`).
262
+
3. Include relevant metadata at the top of the file (title, tags, etc.).
263
+
4. Write the post content, focusing on how the news or change affects OCaml users.
As part of the [OCaml Changelog page](https://ocaml.org/changelog) and the [Backstage OCaml page](https://ocaml.org/backstage), we list stable, and respectively, unstable releases of all the OCaml Platform tools, as well as the OCaml compiler.
283
+
284
+
#### Contributing Release Notes
285
+
286
+
To contribute OCaml Platform Tools release notes:
287
+
288
+
1. Create a new Markdown file in the `data/platform_tools_releases/` directory.
289
+
2. Use a clear, descriptive filename (e.g., `2025-02-03-dune-release-2.1.0.md`).
290
+
3. Include relevant metadata at the top of the file (title, tags, etc.).
291
+
4. Submit a pull request with your new file.
292
+
261
293
## Git and GitHub Workflow
262
294
263
295
The preferred workflow for contributing to a repository is to fork the main repository on GitHub, clone, and develop on a new branch.
0 commit comments