gists
Version:
Methods for working with the GitHub Gist API. Node.js/JavaScript
48 lines (32 loc) • 1.4 kB
Markdown
# Release history
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
<details>
<summary><strong>Guiding Principles</strong></summary>
- Changelogs are for humans, not machines.
- There should be an entry for every single version.
- The same types of changes should be grouped.
- Versions and sections should be linkable.
- The latest version comes first.
- The release date of each versions is displayed.
- Mention whether you follow Semantic Versioning.
</details>
<details>
<summary><strong>Types of changes</strong></summary>
Changelog entries are classified using the following labels _(from [keep-a-changelog](http://keepachangelog.com/)_):
- `Added` for new features.
- `Changed` for changes in existing functionality.
- `Deprecated` for soon-to-be removed features.
- `Removed` for now removed features.
- `Fixed` for any bug fixes.
- `Security` in case of vulnerabilities.
</details>
## 2.0.0 - 2018-08-19
**Breaking changes**
- renamed `.allPublic` => `.public`
- renamed `.comment` => `.createComment`
- renamed `.download` => `.get`
- renamed `.destroy` => `.delete`
- renamed `.destroyComment` => `.deleteComment`
[keep-a-changelog]: https://github.com/olivierlacan/keep-a-changelog