Document the availability of the development version. #1537
Conversation
README.md
Outdated
| @@ -33,6 +33,12 @@ git version 1.7.6 | |||
| hub version 2.2.3 | |||
| ``` | |||
|
|
|||
| if you want to use the latest unstable version, use: | |||
There was a problem hiding this comment.
-
Please start sentences with a capital letter. That would be "If".
-
A prerelease version is not necessarily "unstable". They pass all CI tests. It's just that their feature set changes often and some flags might be removed or renamed.
Also, nobody really wants to "use the latest unstable version". If you phrase it like that, that sounds like there is no benefit to using
--devel, and that there is only a negative consequence: instability. But, the actual benefit is that you gain access to new features quicker. So, let's instead phrase it using a language that reveals a benefit that a user might get from using the--develflag: “If you want to get access to new hub features earlier and help with its development by reporting bugs, you can install the prerelease version”.
There was a problem hiding this comment.
An excellent feedback, thank you. I'll incorporate the language.
PS: I considered phrasing it the same way as you've just proposed but wasn't really sure if that is true so thanks for clearing that up.
|
This is now ready to be re-reviewed @mislav. |
|
Thank you! |
I checked the Chocolatey Gallery and it doesn't seem like there's a prerelease of
hub. So I haven't documented that but Chocolatey itself supports prereleases.