@cryptotaxi247 / kubo / commits / 5a98567e0

apply review

David Dias committed Jul 4, 2019 at 10:20 UTC 5a98567e0d7ed898c2038d290c525a9482091e64
1 file changed +12 -9
docs/releases.md
+12 -9
@@ -9,7 +9,7 @@
9
10 ## Release Philosophy
11
12 -`go-ipfs` aims to have release every six weeks, two releases per quarter. During these 6 week releases, we go through 4 different stages of Release Candidates (RC) that gives us the opportunity to test the new version against our test envinronments, production envinronments, IPFS apps (e.g. Desktop and WebUI) and with our close partners that have IPFS running in Production, by leveraging their own test infrastructure.
12 +`go-ipfs` aims to have release every six weeks, two releases per quarter. During these 6 week releases, we go through 4 different stages of Release Candidates (RC) that gives us the opportunity to test the new version against our test environments (unit, interop, integration), QA in our current production environmment, IPFS apps (e.g. Desktop and WebUI) and with our _early testers_<sup>[1]</sup> that have IPFS running in Production, by leveraging their own test infrastructure and QA systems.
13
14 We might expand the six week release schedule in case of:
15 - No new updates to be added
@@ -20,7 +20,7 @@ We might expand the six week release schedule in case of:
20 `go-ipfs` releases come in 4 stages:
21
22 - **Release Stage 1 - Internal testing** - Test the Release against our testing infrastructure, including interoperability, integration, test lab, multiple runtimes and the apps we've built (WebUI, Desktop, NPM on IPFS, HTTP Client Libraries). The intent is to make this stage fully automated (and somewhat is already), until then, we manually check a list and ensure that all tests have been run
23 -- **Release Stage 2 - Invite IPFS partners to test** - Reach out to our partners (i.e. projects that have volunteered to support `go-ipfs` by using their own test infrastructure and tell us the results)
23 +- **Release Stage 2 - Invite _early testers_ to try it out** - Reach out to our _early testers_ (i.e. projects that have volunteered to support `go-ipfs` by using their own test infrastructure and tell us the results)
24 - **Release Stage 3 - Announce to the broader community** - Communicate to the community that a new Release Candidate is ready and that everyone is welcome to test it with us
25 - **Release Stage 4 - Complete the Release** - Finalize the release, start the next release.
26
@@ -45,7 +45,7 @@ The first step is for the `Lead Maintainer` for `go-ipfs` to open an issue with
45
46 # 🔦 Highlights
47
48 -<List of items with PRs and/or Issues to be considered for this release>
48 +<List of items with PRs and/or Issues included for this release>
49
50 # 🏗 API Changes
51
@@ -83,12 +83,12 @@ When Release Stage 1, there is a features freeze for the release branch.
83 - [ ] IPFS Companion
84 - [ ] NPM on IPFS
85
86 -### Release Stage 2 - Invite IPFS partners to test
86 +### Release Stage 2 - Invite _early testers_ to try it out
87
88 -- [ ] Reach out to the following IPFS partners for testing this release (check when no more problems have been reported):
88 +- [ ] Reach out to the following IPFS _early testers_ for testing this release (check when no more problems have been reported):
89 - [ ] Infura
90 - [ ] Textila
91 - - [ ] Open Bazaar
91 + - [ ] Pinata
92 - [ ] QRI
93 - [ ] Run tests available in the following repos with the latest RC (check when all tests pass):
94 - [ ] [orbit-db](https://github.com/orbitdb/orbit-db)
@@ -105,11 +105,10 @@ PSA: If you are a heavy user of `go-ipfs`, have developed a solid test infrastru
105 - [ ] Invite the community through (link to the release issue):
106 - [ ] [discuss.ipfs.io](https://discuss.ipfs.io/c/announcements)
107 - [ ] Twitter
108 + - [ ] IRC
109
110 ### Release Stage 4 - Complete the Release
111
111 -- 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/alanshaw/5a2d9465c5a05b201d949551bdb1fcc3). Add it to this issue.
112 -
112 - [ ] Final preparation
113 - [ ] Verify that version string in `repo/version.go` has been updated
114 - [ ] tag commit with vX.Y.Z
@@ -142,7 +141,7 @@ Would you like to contribute to the IPFS project and don't know how? Well, there
141
142 # ⁉️ Do you have questions?
143
145 -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.
144 +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, which is also [accessible through our Matrix bridge](https://riot.im/app/#/room/#freenode_#ipfs:matrix.org).
145 ```
146
147 ## Release Version Numbers (aka semver)
@@ -155,3 +154,7 @@ Post `go-ipfs` 1.X.X (future), `go-ipfs` will use semver. This means that only m
154
155 We do not yet retroactively apply fixes to older releases (no Long Term Support releases for now), which means that we always recommend users to update to the latest, whenever possible.
156 TBW
157 +
158 +----------------------------
159 +
160 +- <sup>**[1]**</sup> - _early testers_ is an IPFS program in which members of the community can self-volunteer to help test `go-ipfs` Release Candidates. You find more info about it at [EARLY_TESTERS.md](./EARLY_TESTERS.md)