-
Notifications
You must be signed in to change notification settings - Fork 54
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
Add a CHANGELOG. #167
Comments
Hey Jeff, do you think this is something I'd be able to do? I think I'd just need to know what format to use (I kind of like Cocoapods' myself) and a rough idea of how detailed you want to be for the 1.1 release. |
You're very much welcome to take it on, thanks! I think following Cocoapods' model is a great idea--there's a lot of nice touches to that like the installation link at top; the compare links; and certainly crediting the contributors responsible. Re: detail I think I'd like to describe all the enhancements, and major bug fixes (think "holy shit I can't believe that was broken to begin with" haha, like device support). I'd definitely leave "tech debt" stuff out except for stability improvements. I don't think there are any breaking changes for this release (hence it being 1.1). #143 will require Xcode 5.1--which will be good to note in the CHANGELOG--but it supports iOS 5.1 if you run Mountain Lion and manually install the iOS 5.1 simulator. |
Working document of what git commits to be included in 1.1: https://gist.github.com/MaxGabriel/10001735 (You probably don't want to read this btw—the formatting makes it almost impossible to read and its probably better to wait for the finished changelog and then add stuff from that point). General methodology:Document in the 1.1 changelog:
Don't document in the 1.1 changelog:
(This methodology is specific to 1.1 b/c it has a ton of commits. 1.1.1 or whatever can be more thorough). |
This can be closed—forgot to include this issue in the Changelog PR commit messages to close this one. |
Oh yeah, thanks. |
As we're about to mark 1.1, time to start actually tracking our changes. 1.1's going to be a bit of a doozy to start out--we shouldn't overwhelm the reader, yet convey a sense of how much we've added/fixed since 1.0.1, if possible.
The text was updated successfully, but these errors were encountered: