mirror of
https://github.com/librespot-org/librespot.git
synced 2024-12-18 17:11:53 +00:00
Add changelog
This commit is contained in:
parent
4c875c0e59
commit
e7b3050a90
2 changed files with 34 additions and 1 deletions
31
CHANGELOG.md
Normal file
31
CHANGELOG.md
Normal file
|
@ -0,0 +1,31 @@
|
||||||
|
# Changelog
|
||||||
|
|
||||||
|
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/),
|
||||||
|
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html) since v0.2.0.
|
||||||
|
|
||||||
|
## [Unreleased]
|
||||||
|
|
||||||
|
## [0.2.0] - 2021-05-04
|
||||||
|
|
||||||
|
## [0.1.6] - 2021-02-22
|
||||||
|
|
||||||
|
## [0.1.5] - 2021-02-21
|
||||||
|
|
||||||
|
## [0.1.3] - 2020-07-29
|
||||||
|
|
||||||
|
## [0.1.2] - 2020-07-22
|
||||||
|
|
||||||
|
## [0.1.1] - 2020-01-30
|
||||||
|
|
||||||
|
## [0.1.0] - 2019-11-06
|
||||||
|
|
||||||
|
[unreleased]: https://github.com/librespot-org/librespot/compare/v0.2.0..HEAD
|
||||||
|
[0.2.0]: https://github.com/librespot-org/librespot/compare/v0.1.6..v0.2.0
|
||||||
|
[0.1.6]: https://github.com/librespot-org/librespot/compare/v0.1.5..v0.1.6
|
||||||
|
[0.1.5]: https://github.com/librespot-org/librespot/compare/v0.1.3..v0.1.5
|
||||||
|
[0.1.3]: https://github.com/librespot-org/librespot/compare/v0.1.2..v0.1.3
|
||||||
|
[0.1.2]: https://github.com/librespot-org/librespot/compare/v0.1.1..v0.1.2
|
||||||
|
[0.1.1]: https://github.com/librespot-org/librespot/compare/v0.1.0..v0.1.1
|
||||||
|
[0.1.0]: https://github.com/librespot-org/librespot/releases/tag/v0.1.0
|
|
@ -29,6 +29,8 @@ In order to prepare for a PR, you will need to do a couple of things first:
|
||||||
|
|
||||||
Make any changes that you are going to make to the code, but do not commit yet.
|
Make any changes that you are going to make to the code, but do not commit yet.
|
||||||
|
|
||||||
|
Unless your changes are negligible, please add an entry in the "Unreleased" section of `CHANGELOG.md`. Refer to [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) for instructions on how this entry should look like.
|
||||||
|
|
||||||
Make sure that the code is correctly formatted by running:
|
Make sure that the code is correctly formatted by running:
|
||||||
```bash
|
```bash
|
||||||
cargo +stable fmt --all
|
cargo +stable fmt --all
|
||||||
|
@ -43,7 +45,7 @@ cargo build
|
||||||
Once it has built, and you have confirmed there are no warnings or errors, you should commit your changes.
|
Once it has built, and you have confirmed there are no warnings or errors, you should commit your changes.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
git commit -a -m “My fancy fix”
|
git commit -a -m "My fancy fix"
|
||||||
```
|
```
|
||||||
|
|
||||||
**N.B.** Please, for the sake of a readable history, do not bundle multiple major changes into a single commit. Instead, break it up into multiple commits.
|
**N.B.** Please, for the sake of a readable history, do not bundle multiple major changes into a single commit. Instead, break it up into multiple commits.
|
||||||
|
|
Loading…
Reference in a new issue