https://github.com/kylef/changelog
A formal specification for changelog files and entries
https://github.com/kylef/changelog
Last synced: 8 months ago
JSON representation
A formal specification for changelog files and entries
- Host: GitHub
- URL: https://github.com/kylef/changelog
- Owner: kylef
- License: bsd-2-clause
- Created: 2016-01-15T21:57:54.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2018-09-02T13:27:26.000Z (almost 8 years ago)
- Last Synced: 2025-04-09T10:21:59.922Z (about 1 year ago)
- Size: 4.88 KB
- Stars: 18
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Changelog
A formal specification for semantic changelog files and entries.
## Quick Links
- [Specification](Specification.md)
## Rationale and Goals
The primary goal around the changelog specification is to formalise a structure
for changelog files to bring consistency across projects.
A formal specification around changelogs may also allow automation via tools.
Tools can understand semantics around changes, whether a change is breaking, an
enhancement or a bug fix and automatically determine the next appropriate
[semantic version](http://semver.org) number. Along with dealing with any
manual tasks around changelog management.
## Examples
A small example changelog entry:
```markdown
## 0.2.0
### Enhancements
* Adds support for versions of Swift included in Xcode.
* Added `swiftenv --help`.
```
Or rendered as markdown:
> ## 0.2.0
> ### Enhancements
> * Adds support for versions of Swift included in Xcode.
> * Added `swiftenv --help`.
### Examples Elsewhere
You can find examples of changelogs in the wild in the following projects:
- [swiftenv](https://github.com/kylef/swiftenv/blob/master/CHANGELOG.md)
- [CocoaPods](https://github.com/CocoaPods/CocoaPods/blob/master/CHANGELOG.md)
- [Xcodeproj](https://github.com/CocoaPods/Xcodeproj/blob/master/CHANGELOG.md)
- [Jekyll](https://github.com/jekyll/jekyll/blob/master/History.markdown)
### Parsers & Generators
Interested in programmatically reading or manipulating your changelog?
- [Golang: parkr/changelog](https://github.com/parkr/changelog)