diff --git a/CHANGELOG.md b/CHANGELOG.md index 9847a8c..c0342a8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -25,9 +25,9 @@ and [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/). ### Fixed - [protocol] Use epsilon comparison for `Percentage` equality checks -- [remote] Improve queue refresh handling - [player] Prevent from acquiring output device before playback starts - [player] Default device was not enumerated on Alsa +- [remote] Improve queue refresh handling - [remote] Fix race condition in controller connection setup - [tokens] Fix token expiration check diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4d59f63..08a2f9a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -96,7 +96,33 @@ We follow Rust's idiomatic style and use `rustfmt` and `clippy` to enforce forma ### Documentation -Our goal is to provide thorough documentation for **pleezer**. Contributions to improve documentation are highly valued. We use [Rustdoc](https://doc.rust-lang.org/rustdoc/what-is-rustdoc.html) for generating documentation. Although we currently have limited documentation, we aim to improve this over time and publish it to docs.rs when it's mature enough. +Documentation is a crucial part of **pleezer**. We maintain several types of documentation: + +1. **API Documentation** + - All public APIs must be documented using rustdoc + - Examples should be included where appropriate + - Documentation is published to docs.rs + +2. **User Documentation** + - README.md contains quick start guide and basic usage + - Command-line help text via `--help` flag + +3. **Contributing Guidelines** + - CONTRIBUTING.md (this document) for contributor information + - SECURITY.md for security-related procedures + - CODE_OF_CONDUCT.md for community guidelines + +4. **Change Documentation** + - CHANGELOG.md following Keep a Changelog format + - GitHub releases with detailed release notes + +When contributing: +- Ensure any new code includes appropriate rustdoc comments +- Update relevant documentation files +- Include code examples in rustdoc comments where they would help understanding +- Keep documentation in sync with code changes + +Documentation PRs are highly valued and encouraged, even if they're not accompanied by code changes. ### CI Pipeline diff --git a/Cargo.lock b/Cargo.lock index f0c4e3f..35cbb9a 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -1627,7 +1627,7 @@ checksum = "953ec861398dccce10c670dfeaf3ec4911ca479e9c02154b3a215178c5f566f2" [[package]] name = "pleezer" -version = "0.3.0" +version = "0.4.0" dependencies = [ "base64", "blowfish", diff --git a/Cargo.toml b/Cargo.toml index 31064f5..ee9a3d1 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "pleezer" -version = "0.3.0" +version = "0.4.0" authors = ["Roderick van Domburg"] description = "Headless Deezer Connect player" edition = "2021"