Skip to content
This repository was archived by the owner on Oct 23, 2022. It is now read-only.

Commit 0d6f249

Browse files
author
Joonas Koivunen
committed
chore: describe changelog in CONTRIBUTING
1 parent 722d41a commit 0d6f249

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed

CONTRIBUTING.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,49 @@ Following these principles in your PRs will greatly increase your chances of a s
1919

2020
1. Keep the patch size minimal
2121
2. Aim for high (but not absolute) code coverage in testing
22+
3. Add a note in the changelog(s)
2223

2324
By keeping the patch size minimal we hope to avoid difficult to review situations where there are lot of lines changed with only a few necessary changes. If you wish to submit a pull request for reorganizing something, please keep all unnecessary changes out.
2425

2526
For example, if you wanted to change the wording of this CONTRIBUTING.md file and dislike the fact that there is no static word wrap used, please push two separate pull requests to first change the wording, and finally to reformat the file.
2627

28+
### Changelogs and their format
29+
30+
We currently maintain two CHANGELOG files:
31+
32+
* [`CHANGELOG.md`](./CHANGELOG.md)
33+
* [`unixfs/CHANGELOG.md`](./unixfs/CHANGELOG.md)
34+
35+
If your PR includes changes to `unixfs/`, include a note in the
36+
`unixfs/CHANGELOG.md`. If your PR includes changes elsewhere, include a note in
37+
the root `CHANGELOG.md`.
38+
39+
The changelog format we've used so far in `unixfs/CHANGELOG.md` is:
40+
41+
```
42+
# {release version}
43+
44+
Short overview.
45+
46+
* Short overview [#PR_NUMBER]
47+
48+
[#PR_NUMBER]: PR_URL
49+
```
50+
51+
If you find yourself writing list of things, just make it multiple items in the
52+
list, like:
53+
54+
```
55+
* Short overview, part of [#PR_NUMBER]
56+
* Another thing, part of [#PR_NUMBER]
57+
58+
[#PR_NUMBER]: PR_URL
59+
```
60+
61+
In the changelog the most recently released version should be first. This
62+
changelog format is more free-form than the more familiar separation of fixes
63+
and features. We will probably later migrate to more detailed changelogs.
64+
2765
## Target Build
2866

2967
Rust IPFS will always target the current _stable_ version of Rust that is released. Our CI/CD tests will reflect this. See [instructions here on how to install the rust toolchain](https://doc.rust-lang.org/book/ch01-01-installation.html).

0 commit comments

Comments
 (0)