-
Notifications
You must be signed in to change notification settings - Fork 2.1k
readme: add section on versioning #772
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
This sounds good to me. One thing I'm left wondering is... what does This may all fall under "additional workflows and policies" that you called out in the description above, so maybe it can all be addressed later. |
Nit: The rest of README.md, and Go style at large uses 1 space between sentences, not two. Everything I read sounds reasonable and SGTM, up until this part:
I don't think we should do that, we should have people look that information up in GitHub documentation. I think it would cause too much churn to deal with in our Go package, and it'd end up being too inaccurate and out of date more often than not. It'd cause merge conflicts, delays in PRs being merged, etc. In the end, I see not nearly enough benefit, but huge downsides. Also, as Glenn mention, we need to figure out how |
also fix whitespace between sentences
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. Thank you, @willnorris!
README.md
Outdated
@@ -238,6 +238,29 @@ straightforward. | |||
[roadmap]: https://docs.google.com/spreadsheet/ccc?key=0ApoVX4GOiXr-dGNKN1pObFh6ek1DR2FKUjBNZ1FmaEE&usp=sharing | |||
[contributing]: CONTRIBUTING.md | |||
|
|||
## Versioning ## | |||
|
|||
In general, go-github follows [semver](http://semver.org/) as closely as we can |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
s/http/https/
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fixed.
I've created historical tags for v2.0.0 through v15.0.0, corresponding to each time the |
This does not yet address some of the additional workflows and policies we'll need to adopt as a result. For example, when do we cut new releases, do we attempt to maintain a formal changelog, or at least release notes when we cut a new release, etc. This also requires that we update go docs to call out which methods are exposing preview functionality from the GitHub API.
Fixes #376