Refactored the 2.0.0 changelog #192
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
richleland
suggested changes
Nov 17, 2016
| @@ -10,29 +10,24 @@ This project adheres to [Semantic Versioning](http://semver.org/). | |||
| - An optional "stack identifier" that can be set during [initialization](README.md#initialization) so we can track libraries that use node-sparkpost via the User-Agent header by @ewandennis. | |||
|
|
|||
| ## [2.0.0] - 2016-11-04 - *breaking* | |||
There was a problem hiding this comment.
it might be worth adding a human-readable paragraph here summarizing the changes and that it's a major version release, etc.
| - [#112](https://github.com/SparkPost/node-sparkpost/pull/112) Returns body.results or body as a response. Added debug support. (@aydrian) | ||
| ### Added | ||
| - Support for Promises and Callbacks | ||
| - Debug option on initialization attached debug information on response |
| - Debug option on initialization attached debug information on response | ||
|
|
||
| ### Changed | ||
| - Methods return `data` comprised of the response body. |
There was a problem hiding this comment.
It isn't clear to me what this means. Maybe an example of what this looks like or a link to an example?
There was a problem hiding this comment.
Wasn't sure how to say response.body is returned instead of response
|
|
||
| ### Changed | ||
| - Methods return `data` comprised of the response body. | ||
| - Standardized methods on all API wrappers. See Issue #175. |
There was a problem hiding this comment.
It's supposed to do that automatically according to the Github markdown guide.
| - Now using NPM scripts instead of grunt | ||
|
|
||
| ### Fixed | ||
| - Responses for `GET` requests are now properly parsed as JSON by @aydrian. Closes #111 |
richleland
approved these changes
Nov 17, 2016
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Going forward, we will use Keep a Changelog as a guide.
Addresses #191