Format all the markdown files with markdownlint (#318)
This commit is contained in:
parent
81f2abcdec
commit
5bc1cc0c63
53
CHANGELOG.md
53
CHANGELOG.md
|
@ -1,4 +1,5 @@
|
||||||
# Changelog
|
# Changelog
|
||||||
|
|
||||||
All notable changes to this project will be documented in this file.
|
All notable changes to this project will be documented in this file.
|
||||||
|
|
||||||
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
||||||
|
@ -7,7 +8,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
||||||
## [Unreleased]
|
## [Unreleased]
|
||||||
|
|
||||||
## [1.0.0] - 2017-06-20
|
## [1.0.0] - 2017-06-20
|
||||||
|
|
||||||
### Added
|
### Added
|
||||||
|
|
||||||
- New visual identity by [@tylerfortune8](https://github.com/tylerfortune8).
|
- New visual identity by [@tylerfortune8](https://github.com/tylerfortune8).
|
||||||
- Version navigation.
|
- Version navigation.
|
||||||
- Links to latest released version in previous versions.
|
- Links to latest released version in previous versions.
|
||||||
|
@ -33,9 +36,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
||||||
- Ukrainian translation from [@osadchyi-s](https://github.com/osadchyi-s).
|
- Ukrainian translation from [@osadchyi-s](https://github.com/osadchyi-s).
|
||||||
|
|
||||||
### Changed
|
### Changed
|
||||||
|
|
||||||
- Start using "changelog" over "change log" since it's the common usage.
|
- Start using "changelog" over "change log" since it's the common usage.
|
||||||
- Start versioning based on the current English version at 0.3.0 to help
|
- Start versioning based on the current English version at 0.3.0 to help
|
||||||
translation authors keep things up-to-date.
|
translation authors keep things up-to-date.
|
||||||
- Rewrite "What makes unicorns cry?" section.
|
- Rewrite "What makes unicorns cry?" section.
|
||||||
- Rewrite "Ignoring Deprecations" sub-section to clarify the ideal
|
- Rewrite "Ignoring Deprecations" sub-section to clarify the ideal
|
||||||
scenario.
|
scenario.
|
||||||
|
@ -52,83 +56,112 @@ translation authors keep things up-to-date.
|
||||||
- Fix phrasing and spelling in German translation.
|
- Fix phrasing and spelling in German translation.
|
||||||
|
|
||||||
### Removed
|
### Removed
|
||||||
|
|
||||||
- Section about "changelog" vs "CHANGELOG".
|
- Section about "changelog" vs "CHANGELOG".
|
||||||
|
|
||||||
## [0.3.0] - 2015-12-03
|
## [0.3.0] - 2015-12-03
|
||||||
|
|
||||||
### Added
|
### Added
|
||||||
|
|
||||||
- RU translation from [@aishek](https://github.com/aishek).
|
- RU translation from [@aishek](https://github.com/aishek).
|
||||||
- pt-BR translation from [@tallesl](https://github.com/tallesl).
|
- pt-BR translation from [@tallesl](https://github.com/tallesl).
|
||||||
- es-ES translation from [@ZeliosAriex](https://github.com/ZeliosAriex).
|
- es-ES translation from [@ZeliosAriex](https://github.com/ZeliosAriex).
|
||||||
|
|
||||||
## [0.2.0] - 2015-10-06
|
## [0.2.0] - 2015-10-06
|
||||||
|
|
||||||
### Changed
|
### Changed
|
||||||
|
|
||||||
- Remove exclusionary mentions of "open source" since this project can
|
- Remove exclusionary mentions of "open source" since this project can
|
||||||
benefit both "open" and "closed" source projects equally.
|
benefit both "open" and "closed" source projects equally.
|
||||||
|
|
||||||
## [0.1.0] - 2015-10-06
|
## [0.1.0] - 2015-10-06
|
||||||
|
|
||||||
### Added
|
### Added
|
||||||
|
|
||||||
- Answer "Should you ever rewrite a change log?".
|
- Answer "Should you ever rewrite a change log?".
|
||||||
|
|
||||||
### Changed
|
### Changed
|
||||||
|
|
||||||
- Improve argument against commit logs.
|
- Improve argument against commit logs.
|
||||||
- Start following [SemVer](https://semver.org) properly.
|
- Start following [SemVer](https://semver.org) properly.
|
||||||
|
|
||||||
## [0.0.8] - 2015-02-17
|
## [0.0.8] - 2015-02-17
|
||||||
|
|
||||||
### Changed
|
### Changed
|
||||||
|
|
||||||
- Update year to match in every README example.
|
- Update year to match in every README example.
|
||||||
- Reluctantly stop making fun of Brits only, since most of the world
|
- Reluctantly stop making fun of Brits only, since most of the world
|
||||||
writes dates in a strange way.
|
writes dates in a strange way.
|
||||||
|
|
||||||
### Fixed
|
### Fixed
|
||||||
|
|
||||||
- Fix typos in recent README changes.
|
- Fix typos in recent README changes.
|
||||||
- Update outdated unreleased diff link.
|
- Update outdated unreleased diff link.
|
||||||
|
|
||||||
## [0.0.7] - 2015-02-16
|
## [0.0.7] - 2015-02-16
|
||||||
|
|
||||||
### Added
|
### Added
|
||||||
|
|
||||||
- Link, and make it obvious that date format is ISO 8601.
|
- Link, and make it obvious that date format is ISO 8601.
|
||||||
|
|
||||||
### Changed
|
### Changed
|
||||||
|
|
||||||
- Clarified the section on "Is there a standard change log format?".
|
- Clarified the section on "Is there a standard change log format?".
|
||||||
|
|
||||||
### Fixed
|
### Fixed
|
||||||
|
|
||||||
- Fix Markdown links to tag comparison URL with footnote-style links.
|
- Fix Markdown links to tag comparison URL with footnote-style links.
|
||||||
|
|
||||||
## [0.0.6] - 2014-12-12
|
## [0.0.6] - 2014-12-12
|
||||||
|
|
||||||
### Added
|
### Added
|
||||||
|
|
||||||
- README section on "yanked" releases.
|
- README section on "yanked" releases.
|
||||||
|
|
||||||
## [0.0.5] - 2014-08-09
|
## [0.0.5] - 2014-08-09
|
||||||
|
|
||||||
### Added
|
### Added
|
||||||
|
|
||||||
- Markdown links to version tags on release headings.
|
- Markdown links to version tags on release headings.
|
||||||
- Unreleased section to gather unreleased changes and encourage note
|
- Unreleased section to gather unreleased changes and encourage note
|
||||||
keeping prior to releases.
|
keeping prior to releases.
|
||||||
|
|
||||||
## [0.0.4] - 2014-08-09
|
## [0.0.4] - 2014-08-09
|
||||||
|
|
||||||
### Added
|
### Added
|
||||||
|
|
||||||
- Better explanation of the difference between the file ("CHANGELOG")
|
- Better explanation of the difference between the file ("CHANGELOG")
|
||||||
and its function "the change log".
|
and its function "the change log".
|
||||||
|
|
||||||
### Changed
|
### Changed
|
||||||
|
|
||||||
- Refer to a "change log" instead of a "CHANGELOG" throughout the site
|
- Refer to a "change log" instead of a "CHANGELOG" throughout the site
|
||||||
to differentiate between the file and the purpose of the file — the
|
to differentiate between the file and the purpose of the file — the
|
||||||
logging of changes.
|
logging of changes.
|
||||||
|
|
||||||
### Removed
|
### Removed
|
||||||
|
|
||||||
- Remove empty sections from CHANGELOG, they occupy too much space and
|
- Remove empty sections from CHANGELOG, they occupy too much space and
|
||||||
create too much noise in the file. People will have to assume that the
|
create too much noise in the file. People will have to assume that the
|
||||||
missing sections were intentionally left out because they contained no
|
missing sections were intentionally left out because they contained no
|
||||||
notable changes.
|
notable changes.
|
||||||
|
|
||||||
## [0.0.3] - 2014-08-09
|
## [0.0.3] - 2014-08-09
|
||||||
|
|
||||||
### Added
|
### Added
|
||||||
|
|
||||||
- "Why should I care?" section mentioning The Changelog podcast.
|
- "Why should I care?" section mentioning The Changelog podcast.
|
||||||
|
|
||||||
## [0.0.2] - 2014-07-10
|
## [0.0.2] - 2014-07-10
|
||||||
|
|
||||||
### Added
|
### Added
|
||||||
|
|
||||||
- Explanation of the recommended reverse chronological release ordering.
|
- Explanation of the recommended reverse chronological release ordering.
|
||||||
|
|
||||||
## [0.0.1] - 2014-05-31
|
## [0.0.1] - 2014-05-31
|
||||||
|
|
||||||
### Added
|
### Added
|
||||||
|
|
||||||
- This CHANGELOG file to hopefully serve as an evolving example of a
|
- This CHANGELOG file to hopefully serve as an evolving example of a
|
||||||
standardized open source project CHANGELOG.
|
standardized open source project CHANGELOG.
|
||||||
- CNAME file to enable GitHub Pages custom domain
|
- CNAME file to enable GitHub Pages custom domain
|
||||||
|
@ -136,7 +169,7 @@ notable changes.
|
||||||
- Good examples and basic guidelines, including proper date formatting.
|
- Good examples and basic guidelines, including proper date formatting.
|
||||||
- Counter-examples: "What makes unicorns cry?"
|
- Counter-examples: "What makes unicorns cry?"
|
||||||
|
|
||||||
[Unreleased]: https://github.com/olivierlacan/keep-a-changelog/compare/v1.0.0...HEAD
|
[unreleased]: https://github.com/olivierlacan/keep-a-changelog/compare/v1.0.0...HEAD
|
||||||
[1.0.0]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.3.0...v1.0.0
|
[1.0.0]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.3.0...v1.0.0
|
||||||
[0.3.0]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.2.0...v0.3.0
|
[0.3.0]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.2.0...v0.3.0
|
||||||
[0.2.0]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.1.0...v0.2.0
|
[0.2.0]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.1.0...v0.2.0
|
||||||
|
|
|
@ -8,19 +8,19 @@ In the interest of fostering an open and welcoming environment, we as contributo
|
||||||
|
|
||||||
Examples of behavior that contributes to creating a positive environment include:
|
Examples of behavior that contributes to creating a positive environment include:
|
||||||
|
|
||||||
* Using welcoming and inclusive language
|
- Using welcoming and inclusive language
|
||||||
* Being respectful of differing viewpoints and experiences
|
- Being respectful of differing viewpoints and experiences
|
||||||
* Gracefully accepting constructive criticism
|
- Gracefully accepting constructive criticism
|
||||||
* Focusing on what is best for the community
|
- Focusing on what is best for the community
|
||||||
* Showing empathy towards other community members
|
- Showing empathy towards other community members
|
||||||
|
|
||||||
Examples of unacceptable behavior by participants include:
|
Examples of unacceptable behavior by participants include:
|
||||||
|
|
||||||
* The use of sexualized language or imagery and unwelcome sexual attention or advances
|
- The use of sexualized language or imagery and unwelcome sexual attention or advances
|
||||||
* Trolling, insulting/derogatory comments, and personal or political attacks
|
- Trolling, insulting/derogatory comments, and personal or political attacks
|
||||||
* Public or private harassment
|
- Public or private harassment
|
||||||
* Publishing others' private information, such as a physical or electronic address, without explicit permission
|
- Publishing others' private information, such as a physical or electronic address, without explicit permission
|
||||||
* Other conduct which could reasonably be considered inappropriate in a professional setting
|
- Other conduct which could reasonably be considered inappropriate in a professional setting
|
||||||
|
|
||||||
## Our Responsibilities
|
## Our Responsibilities
|
||||||
|
|
||||||
|
|
|
@ -1,12 +1,13 @@
|
||||||
# <img src="https://d3vv6lp55qjaqc.cloudfront.net/items/1L1w0v431V0d1K410f3Y/keepAChangelog-logo-dark.svg" height=150 alt="Keep a Changelog" />
|
# <img src="https://d3vv6lp55qjaqc.cloudfront.net/items/1L1w0v431V0d1K410f3Y/keepAChangelog-logo-dark.svg" height=150 alt="Keep a Changelog" />
|
||||||
|
|
||||||
[![version][version-badge]][CHANGELOG] [![license][license-badge]][LICENSE]
|
[![version][version-badge]][changelog] [![license][license-badge]][license]
|
||||||
|
|
||||||
Don’t let your friends dump git logs into changelogs™
|
Don’t let your friends dump git logs into changelogs™
|
||||||
|
|
||||||
This repository generates https://keepachangelog.com/.
|
This repository generates https://keepachangelog.com/.
|
||||||
|
|
||||||
## Development
|
## Development
|
||||||
|
|
||||||
### Dependencies
|
### Dependencies
|
||||||
|
|
||||||
- Ruby ([see version][ruby-version], [rbenv][rbenv] recommended)
|
- Ruby ([see version][ruby-version], [rbenv][rbenv] recommended)
|
||||||
|
@ -27,6 +28,7 @@ This repository generates https://keepachangelog.com/.
|
||||||
- `docker run -p 4567:4567 keep-a-changelog` starts the docker development server and binds it at http://localhost:4567
|
- `docker run -p 4567:4567 keep-a-changelog` starts the docker development server and binds it at http://localhost:4567
|
||||||
|
|
||||||
### Deployment
|
### Deployment
|
||||||
|
|
||||||
- `bundle exec rake publish` builds and pushes to the `gh-pages` branch
|
- `bundle exec rake publish` builds and pushes to the `gh-pages` branch
|
||||||
|
|
||||||
### Translations
|
### Translations
|
||||||
|
@ -52,8 +54,8 @@ Please do contribute! Issues and pull requests are welcome.
|
||||||
|
|
||||||
Thank you for your help improving software one changelog at a time!
|
Thank you for your help improving software one changelog at a time!
|
||||||
|
|
||||||
[CHANGELOG]: ./CHANGELOG.md
|
[changelog]: ./CHANGELOG.md
|
||||||
[LICENSE]: ./LICENSE
|
[license]: ./LICENSE
|
||||||
[rbenv]: https://github.com/rbenv/rbenv
|
[rbenv]: https://github.com/rbenv/rbenv
|
||||||
[ruby-version]: .ruby-version
|
[ruby-version]: .ruby-version
|
||||||
[source]: source/
|
[source]: source/
|
||||||
|
|
Loading…
Reference in New Issue