dexoron/dcr
1
1
Fork 0
mirror of https://github.com/dexoron/dcr.git synced 2026-10-21 14:38:30 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
617ba8544235a6a0a1ac9bca0eee7fec4dd68b17
dcr/CONTRIBUTING.md
Dexoron d1e3b0c384 Added: 
- `sharedlib` build kind (shared library output)
- ASM projects (`build.language = "asm"`)
- NASM and GAS backends
- `build.platform` architecture hint for `-march` / `/arch`
- Basic CLI integration tests
2026-03-01 19:47:38 +08:00

1.1 KiB
Raw Blame History

Contributing

Thanks for your interest in the project.

Requirements

  • Use Rust stable.
  • Before opening a PR, the code must pass formatting, linting, and build.

Quick Start

git clone https://github.com/dexoron/dcr.git
cd dcr
cargo check

Code Style

  • Format code with cargo fmt.
  • Check warnings with cargo clippy.
  • Keep functions small and focused.
  • Prefer clear names over clever ones.

Checks

Before PR, run:

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

CI/CD and Releases

  • CI: .github/workflows/ci.yml
  • Release: .github/workflows/release.yml
  • Releases are triggered by tags v* and publish binaries for:
  • x86_64-unknown-linux-gnu
  • x86_64-apple-darwin
  • aarch64-apple-darwin
  • x86_64-pc-windows-msvc

Commits and PRs

  • Write clear commit messages.
  • In PRs, include a short description and rationale.
  • Update documentation when behavior changes.

Questions

If anything is unclear, open an issue or ask in the PR.

You can also reach out directly: