Thank you for your interest in contributing! This document outlines the development workflow and quality standards for this project.
- Rust (stable, edition 2024)
- cargo-deny (dependency auditing)
- pre-commit (optional, for local hooks)
git clone https://github.com/Xuepoo/agent-lx-music.git
cd agent-lx-music
cargo build
cargo testBefore submitting a PR, ensure:
# Formatting
cargo fmt --check
# Linting
cargo clippy -- -D warnings
# Tests
cargo test
# Dependency audit (if deny.toml exists)
cargo deny checkWe use Conventional Commits:
| Prefix | Usage |
|---|---|
feat: |
New feature |
fix: |
Bug fix |
docs: |
Documentation only |
refactor: |
Code change (no feature/fix) |
test: |
Adding or updating tests |
ci: |
CI/CD changes |
deps: |
Dependency updates |
chore: |
Maintenance tasks |
- Fork the repo and create a feature branch from
main - Make your changes with clear, atomic commits
- Ensure all CI checks pass
- Open a PR using the provided template
- Wait for review — we aim to respond within 48 hours
Releases are automated via CI. When a version tag (v*) is pushed:
- CI builds binaries for all supported platforms
- Packages (.deb, .rpm, .pkg.tar.zst) are created
- GitHub Release is published
- Crates.io, Docker Hub, AUR, Homebrew, and Scoop are updated
To create a release:
# Bump version in Cargo.toml
cargo release patch # or minor, major
git tag v0.x.y
git push origin v0.x.yBy contributing, you agree that your contributions will be licensed under the MIT License.