mirror of
https://github.com/dexoron/dcr.git
synced 2026-10-21 21:59:37 +00:00
54 lines
932 B
Plaintext
54 lines
932 B
Plaintext
---
|
|
sidebar_label: Contributing
|
|
---
|
|
|
|
# Contributing
|
|
|
|
## Setup
|
|
|
|
```bash
|
|
git clone https://github.com/dexoron/dcr
|
|
# or a source mirror: GitVerse / SourceCraft / SourceForge / GitLab (see README)
|
|
cd dcr
|
|
cargo build
|
|
```
|
|
|
|
## Code style
|
|
|
|
All code must be formatted with `cargo fmt`:
|
|
|
|
```bash
|
|
cargo fmt
|
|
```
|
|
|
|
## Linting
|
|
|
|
```bash
|
|
cargo clippy --all-targets -- -D warnings
|
|
```
|
|
|
|
## Tests
|
|
|
|
```bash
|
|
cargo test --all-targets
|
|
```
|
|
|
|
## PR process
|
|
|
|
1. Fork the repository
|
|
2. Create a branch: `git checkout -b feature/description`
|
|
3. Make changes
|
|
4. Run `cargo fmt && cargo clippy && cargo test`
|
|
5. Open a Pull Request
|
|
|
|
## CI
|
|
|
|
CI runs (see `.github/workflows/ci.yml`):
|
|
|
|
* `cargo fmt --check`
|
|
* `cargo clippy` (default + `--all-features`)
|
|
* `cargo check --all-targets --all-features`
|
|
* Unit + integration tests on Linux, macOS, Windows
|
|
* Extra Linux job with `--features archive` (FAT images)
|
|
* Tools on runners: clang, nasm, clang-format/tidy (Linux)
|