Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
46 lines (36 loc) · 1.21 KB

CONTRIBUTING.md

File metadata and controls

46 lines (36 loc) · 1.21 KB

Contributing to RGM

Thanks for contributing.

Development Standards

  • Use clear, product-facing English in PR descriptions and release-facing docs.
  • Prefer small, focused commits using Conventional Commit style (feat:, fix:, chore:, etc.).
  • Keep behavior changes and refactors separated when possible.

Local Validation (required)

Run before opening a PR:

cargo check
cargo test
cargo clippy --all-targets --all-features -- -D warnings

If your change affects packaging, also validate package artifacts:

cargo build --release
cargo deb --no-build
cargo generate-rpm

PR Requirements

  • Explain the problem and the solution.
  • Include user impact and rollback risk.
  • Add screenshots for UI updates.
  • Include a short Release Notes draft in English.

Release Process

  • Releases are tag-driven via .github/workflows/release.yml.
  • Push a semantic tag like v0.2.6 to trigger packaging and release publication.
  • Keep Cargo.toml version aligned with release tag.

Commit Message Convention

Use Conventional Commits:

  • feat(scope): ...
  • fix(scope): ...
  • docs(scope): ...
  • ci(scope): ...
  • chore(scope): ...

This keeps changelogs and release notes clean and reviewable.