Skip to content

Commit c07ffa1

Browse files
authored
docs: add release checklist
1 parent b7f67f2 commit c07ffa1

File tree

1 file changed

+43
-0
lines changed

1 file changed

+43
-0
lines changed

RELEASE.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Release Template
2+
3+
> short tl;dr; of the release
4+
5+
# 🗺 What's left for release
6+
7+
# 🔦 Highlights
8+
9+
# 🏗 API Changes
10+
11+
# ✅ Release Checklist
12+
13+
- Robustness and quality
14+
- [ ] Ensure that all tests are passing, this includes:
15+
- [ ] unit
16+
- [ ] interop
17+
- [ ] sharness
18+
- [ ] Run tests of the following projects with the new release:
19+
- [ ] [js-ipfs](https://github.com/ipfs/js-ipfs)
20+
- Documentation
21+
- [ ] Ensure that README.md is up to date
22+
- [ ] Ensure that all the examples run
23+
- Communication
24+
- [ ] Create the release issue
25+
- [ ] Announcements (both pre-release and post-release)
26+
- [ ] Twitter
27+
- [ ] IRC
28+
- [ ] Reddit
29+
- [ ] Blog post
30+
31+
# 🙌🏽Want to contribute?
32+
33+
Would you like to contribute to the libp2p project and don't know how? Well, there are a few places you can get started:
34+
35+
- 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
36+
- 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
37+
- 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
38+
- Join the discussion at http://discuss.ipfs.io/ and help users finding their answers.
39+
- Join the [⚡️ⒿⓈ Core Dev Team Weekly Sync 🙌🏽 ](https://github.com/ipfs/pm/issues/650) and be part of the Sprint action!
40+
41+
# ⁉️ Do you have questions?
42+
43+
The best place to ask your questions about IPFS, how it works and what you can do with it is at [discuss.ipfs.io](http://discuss.ipfs.io). We are also available at the #ipfs channel on Freenode.

0 commit comments

Comments
 (0)