Skip to content

Commit 8ab5f43

Browse files
committed
doc: update CONTRIBUTING.md about the changelog structure
Signed-off-by: Etienne Marais <[email protected]>
1 parent a06d9d4 commit 8ab5f43

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

CONTRIBUTING.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,12 +36,15 @@ Our development process is as follows:
3636
Exchanges in meetings and chat are valuable, but we insist on deliberating and
3737
recording the what and why of our work in the persistent record of GitHub.
3838
- Changes are submitted via GitHub pull requests against the `main` branch.
39+
- Technical changes must appear in the project Changelog. Learn more on how to
40+
[update the changelog][update changelog].
3941

4042
If you are looking to get started, check our issues tagged with [good first
4143
issue][good first issue] or [help wanted][help wanted].
4244

4345
[good first issue]: https://github.com/ocaml/dune/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22good%20first%20issue%22
4446
[help wanted]: https://github.com/ocaml/dune/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22help%20wanted%22
47+
[update changelog]: https://github.com/ocaml/dune/blob/main/CONTRIBUTING.md#updating-the-changelog
4548

4649
Developer documentation
4750
-----------------------
@@ -131,3 +134,16 @@ you have the rights to submit this work under the same open source license.
131134
[js]: https://www.janestreet.com/
132135
[tarides]: https://tarides.com/
133136
[hack]: ./doc/hacking.rst
137+
138+
Updating the Changelog
139+
----------------------
140+
141+
In Dune, the Changelog is in `CHANGES.md`. As they are many contributions at
142+
the same time and to prevent an infinite cycle of rebase, the `CHANGES.md` file
143+
is only updated when releasing Dune. To keep track of the changes, they must be
144+
recorded inside `doc/changes/`. The name of the file is `<PR number>.md`.
145+
Depending on the nature of the change, it can live inside three categories:
146+
`added`, `changed`, `fixed`, where:
147+
- `added` records every new feature or behaviour inside of Dune
148+
- `changed` records a difference of behaviour with the previous version
149+
- `fixed` records any change that restores the behaviour as expected

0 commit comments

Comments
 (0)