Skip to content

Commit dcf59a8

Browse files
committed
chore: update the release template
1 parent ab028a2 commit dcf59a8

File tree

1 file changed

+18
-2
lines changed

1 file changed

+18
-2
lines changed

RELEASE.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,29 +13,45 @@
1313
- Robustness and quality
1414
- [ ] Ensure that all tests are passing, this includes:
1515
- [ ] unit
16+
- [ ] Publish a release candidate to npm
17+
```sh
18+
# Minor prerelease (e.g. 0.24.1 -> 0.25.0-rc.0)
19+
$ npx aegir release --type preminor -t node -t browser --preid rc --dist-tag next
20+
21+
# Increment prerelease (e.g. 0.25.0-rc.0 -> 0.25.0-rc.1)
22+
$ npx aegir release --type prerelease -t node -t browser --preid rc --dist-tag next
23+
```
1624
- [ ] Run tests of the following projects with the new release:
1725
- [ ] [js-ipfs](https://github.com/ipfs/js-ipfs)
1826
- Documentation
1927
- [ ] Ensure that README.md is up to date
2028
- [ ] Ensure that all the examples run
2129
- Communication
2230
- [ ] Create the release issue
31+
- [ ] Take a snapshot between of everyone that has contributed to this release (including its subdeps in IPFS, libp2p, IPLD and multiformats) using [`name-your-contributors`](https://www.npmjs.com/package/name-your-contributors). Generate a nice markdown list with [this script](https://gist.github.com/jacobheun/d2ff479ca991733c13cdcf688a1317e5)
2332
- [ ] Announcements (both pre-release and post-release)
2433
- [ ] Twitter
2534
- [ ] IRC
2635
- [ ] Reddit
2736
- [ ] [discuss.ipfs.io](https://discuss.ipfs.io/c/announcements)
2837
- [ ] Blog post
38+
- [ ] Copy release notes to the [GitHub Release description](https://github.com/libp2p/js-libp2p/releases)
39+
40+
# ❤️ Huge thank you to everyone that made this release possible
41+
42+
In alphabetical order, here are all the humans that contributed to the release:
43+
44+
- ...
2945

3046
# 🙌🏽 Want to contribute?
3147

3248
Would you like to contribute to the libp2p project and don't know how? Well, there are a few places you can get started:
3349
3450
- Check the issues with the `help wanted` label at the Ready column in our waffle board - https://waffle.io/libp2p/js-libp2p?label=help%20wanted
35-
- Join an IPFS All Hands, introduce yourself and let us know where you would like to contribute - https://github.com/ipfs/pm/#all-hands-call
51+
- Join an IPFS All Hands, introduce yourself and let us know where you would like to contribute - https://github.com/ipfs/team-mgmt#all-hands-call
3652
- Hack with IPFS and show us what you made! The All Hands call is also the perfect venue for demos, join in and show us what you built
3753
- Join the discussion at http://discuss.ipfs.io/ and help users finding their answers.
38-
- Join the [⚡️ⒿⓈ Core Dev Team Weekly Sync 🙌🏽 ](https://github.com/ipfs/pm/issues/650) and be part of the Sprint action!
54+
- Join the [⚡️ⒿⓈ Core Dev Team Weekly Sync 🙌🏽 ](https://github.com/ipfs/team-mgmt/issues/650) and be part of the Sprint action!
3955
4056
# ⁉️ Do you have questions?
4157

0 commit comments

Comments
 (0)