From 0d6f249b7f3e0289cee6b45c2a3774f4476b2faa Mon Sep 17 00:00:00 2001 From: Joonas Koivunen Date: Thu, 24 Sep 2020 11:35:26 +0300 Subject: [PATCH 1/3] chore: describe changelog in CONTRIBUTING --- CONTRIBUTING.md | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5904c1a8f..5928f836c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -19,11 +19,49 @@ Following these principles in your PRs will greatly increase your chances of a s 1. Keep the patch size minimal 2. Aim for high (but not absolute) code coverage in testing +3. Add a note in the changelog(s) 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. 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. +### Changelogs and their format + +We currently maintain two CHANGELOG files: + +* [`CHANGELOG.md`](./CHANGELOG.md) +* [`unixfs/CHANGELOG.md`](./unixfs/CHANGELOG.md) + +If your PR includes changes to `unixfs/`, include a note in the +`unixfs/CHANGELOG.md`. If your PR includes changes elsewhere, include a note in +the root `CHANGELOG.md`. + +The changelog format we've used so far in `unixfs/CHANGELOG.md` is: + +``` +# {release version} + +Short overview. + +* Short overview [#PR_NUMBER] + +[#PR_NUMBER]: PR_URL +``` + +If you find yourself writing list of things, just make it multiple items in the +list, like: + +``` +* Short overview, part of [#PR_NUMBER] +* Another thing, part of [#PR_NUMBER] + +[#PR_NUMBER]: PR_URL +``` + +In the changelog the most recently released version should be first. This +changelog format is more free-form than the more familiar separation of fixes +and features. We will probably later migrate to more detailed changelogs. + ## Target Build 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). From 435d146ad14cdb8e01f877b5d7671f905cab5935 Mon Sep 17 00:00:00 2001 From: Joonas Koivunen Date: Thu, 24 Sep 2020 11:35:46 +0300 Subject: [PATCH 2/3] chore: prepare CHANGELOGs for Next version --- CHANGELOG.md | 6 ++++++ unixfs/CHANGELOG.md | 2 ++ 2 files changed, 8 insertions(+) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 000000000..d33d636b9 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,6 @@ +# Next + +# 0.2.0 + +First real release, with big changes and feature improvements. Started tracking +a changelog. diff --git a/unixfs/CHANGELOG.md b/unixfs/CHANGELOG.md index b52f478e5..327f08ef7 100644 --- a/unixfs/CHANGELOG.md +++ b/unixfs/CHANGELOG.md @@ -1,3 +1,5 @@ +# Next + # 0.2.0 Minor version bump due to ipfs 0.2.0 release. From 263c1e0496276e89d2ef58ebb6ec6315fe102bb2 Mon Sep 17 00:00:00 2001 From: Joonas Koivunen Date: Thu, 24 Sep 2020 11:37:14 +0300 Subject: [PATCH 3/3] chore: add checkbox for CHANGELOG.mds in PR template --- .github/pull_request_template.md | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 67b063531..5b7e49bc8 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -9,3 +9,4 @@ - [ ] Each command has a usage example and API specification - [ ] Rustdoc tests are passing on all code-level comments - [ ] Differences between Rust’s IPFS implementation and the Go or JS implementations are explained +- [ ] Additions to CHANGELOG.md files