Skip to content

docs: add warning-free build requirement to CONTRIBUTING.md #124

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rexlunae merged 1 commit into from
Mar 20, 2026
Merged

docs: add warning-free build requirement to CONTRIBUTING.md #124

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,20 @@ cargo clippy
cargo fmt --check
```

### Pre-PR Checklist

Before opening a PR, ensure your changes compile without warnings:

```bash
# Check library builds warning-free
cargo check --all-features 2>&1 | grep -E "warning:" && echo "Fix warnings before submitting" || echo "✓ No warnings"

# Check tests compile warning-free
cargo test --no-run 2>&1 | grep -E "warning:" && echo "Fix test warnings before submitting" || echo "✓ No test warnings"
```

**No PR should be considered finished while warnings are still present.** Warnings slow down compilation, make CI noisier, and often indicate real issues.

## Code Style

- Follow Rust conventions (rustfmt enforced)
Expand Down
Loading