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

Commit 05b2a82

Browse files
bors[bot]Joonas Koivunen
and
Joonas Koivunen
authored
Merge #400
400: Start tracking changelog r=koivunej a=koivunej Closes #171: - CONTRIBUTING.md description, algorithm for choosing the CHANGELOG file - pull_request_template.md - CHANGELOG.md and unixfs/CHANGELOG.md preparation with `# Next` Co-authored-by: Joonas Koivunen <[email protected]>
2 parents 4348c56 + 263c1e0 commit 05b2a82

File tree

4 files changed

+47
-0
lines changed

4 files changed

+47
-0
lines changed

.github/pull_request_template.md

+1
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,4 @@
99
- [ ] Each command has a usage example and API specification
1010
- [ ] Rustdoc tests are passing on all code-level comments
1111
- [ ] Differences between Rust’s IPFS implementation and the Go or JS implementations are explained
12+
- [ ] Additions to CHANGELOG.md files

CHANGELOG.md

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Next
2+
3+
# 0.2.0
4+
5+
First real release, with big changes and feature improvements. Started tracking
6+
a changelog.

CONTRIBUTING.md

+38
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).

unixfs/CHANGELOG.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# Next
2+
13
# 0.2.0
24

35
Minor version bump due to ipfs 0.2.0 release.

0 commit comments

Comments
 (0)