Skip to content

Commit cfc1a68

Browse files
committed
update CONTRIBUTING.md
1 parent 58c9c7f commit cfc1a68

File tree

1 file changed

+37
-5
lines changed

1 file changed

+37
-5
lines changed

CONTRIBUTING.md

Lines changed: 37 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,19 +18,24 @@ Please include images and browser-specific information if the bug is related to
1818

1919
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).
2020

21+
Anyone can contribute to these sections:
2122
- [Images](#images)
2223
- [The OCaml Planet](#ocaml-planet)
2324
- [Job Board](#content-job)
24-
- [Success Stories](#content-success-story)
2525
- [Academic Users](#content-academic-user)
2626
- [Industrial Users](#content-industrial-user)
2727
- [OCaml Books](#content-book)
2828
- [OCaml Cookbook Recipes](#content-cookbook)
2929
- [Recurring Events](#content-recurring-event)
3030
- [Upcoming Events](#content-upcoming_event)
31+
32+
OCaml Platform maintainers can contribute to these sections:
33+
- [Success Stories](#content-success-story)
3134
- [The OCaml Changelog](#content-changelog)
35+
- [Backstage OCaml](#content-backstage)
36+
- [Platform Tools Releases](#content-platform-tools-releases)
3237

33-
The following sections give more details on how to contribute to each.
38+
The following sections give more details on how to contribute.
3439

3540
### <a name="images"></a>Adding Images
3641

@@ -221,7 +226,7 @@ You can add a new upcoming event by creating a new Markdown file in [data/events
221226

222227
### <a name="content-changelog"></a>OCaml Changelog
223228

224-
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.
225230

226231
The Changelog covers developments across:
227232

@@ -253,11 +258,38 @@ The Changelog is not meant for:
253258
To contribute a new post to the Changelog:
254259

255260
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.
264+
5. Submit a pull request with your new file.
265+
266+
### <a name="content-backstage"></a>Backstage OCaml
267+
268+
As a dual to the OCaml Changelog, Backstage OCaml is a channel TODO
269+
270+
#### Contributing a Post
271+
272+
To contribute a new post to Backstage OCaml:
273+
274+
1. Create a new Markdown file in the `data/backstage/` directory.
275+
2. Use a clear, descriptive filename (e.g., `2025-06-05-portable-external-dependencies-for-dune-package-management.md`).
276+
3. Include relevant metadata at the top of the file (title, tags, etc.).
258277
4. Write the post content, focusing on how the news or change affects OCaml users.
259278
5. Submit a pull request with your new file.
260279

280+
### <a name="content-platform-tools-release"></a>Platform Tools Releases
281+
282+
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+
261293
## Git and GitHub Workflow
262294

263295
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

Comments
 (0)