chore: add pre-commit check script and contributing guide

copyleftdev · copyleftdev · commit 91b353ceb9ea · 2025-10-26T23:38:12.000-07:00
- Add scripts/check.sh for running all checks locally
- Add CONTRIBUTING.md with development workflow
- Document pre-commit checklist (build, fmt, clippy, test, doc)
- Enforce running checks before pushing to CI

This ensures we catch issues locally before wasting CI resources.

Usage:
  ./scripts/check.sh

Quality checks:
✅ Build successful
✅ Formatting verified
✅ Clippy passed (zero warnings)
✅ All tests passed (35 tests)
✅ Documentation built
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,109 @@
+# Contributing to RASN
+
+## Development Workflow
+
+### Before Every Commit
+
+**Always run the pre-commit checks locally:**
+
+```bash
+./scripts/check.sh
+```
+
+Or manually run each step:
+
+```bash
+# 1. Build
+cargo build --all-features
+
+# 2. Format check
+cargo fmt --all -- --check
+
+# 3. Clippy (linting)
+cargo clippy --all-targets --all-features -- -D warnings
+
+# 4. Tests
+cargo test --all-features
+
+# 5. Documentation
+cargo doc --no-deps --all-features
+```
+
+### Auto-formatting
+
+To automatically fix formatting issues:
+
+```bash
+cargo fmt --all
+```
+
+### Running Benchmarks
+
+```bash
+# Run all benchmarks
+cargo bench
+
+# Run specific benchmark
+cargo bench --bench arrow_lookup
+```
+
+### Quality Standards
+
+- **Zero warnings**: All code must compile without warnings
+- **Zero clippy violations**: Fix all clippy suggestions
+- **All tests passing**: 100% test success required
+- **Formatted code**: Run `cargo fmt` before committing
+- **Documentation**: Public APIs must have doc comments
+
+### Git Workflow
+
+1. Create feature branch: `git checkout -b feature/issue-X-description`
+2. Make changes
+3. **Run checks locally**: `./scripts/check.sh`
+4. Commit: `git commit -m "feat(scope): description"`
+5. Push: `git push origin feature/issue-X-description`
+6. Create PR
+7. Wait for CI to pass
+8. Merge with squash
+
+### Commit Message Format
+
+```
+<type>(<scope>): <subject>
+
+<body>
+
+Fixes #<issue-number>
+```
+
+**Types:**
+- `feat`: New feature
+- `fix`: Bug fix
+- `docs`: Documentation changes
+- `test`: Test additions/changes
+- `refactor`: Code refactoring
+- `perf`: Performance improvements
+- `chore`: Maintenance tasks
+
+**Examples:**
+```
+feat(arrow): add SIMD AVX2 acceleration
+fix(db): correct RocksDB API usage
+docs(readme): update installation instructions
+test(resolver): add cache expiry tests
+```
+
+## Running CI Checks Locally
+
+Our CI runs on:
+- Ubuntu (Linux)
+- macOS
+- Windows
+
+All checks must pass on your local machine before pushing.
+
+## Need Help?
+
+- Check existing issues
+- Read the documentation in `/docs`
+- Ask questions in discussions
diff --git a/scripts/check.sh b/scripts/check.sh
@@ -0,0 +1,32 @@
+#!/usr/bin/env bash
+set -e
+
+echo "🔍 Running pre-commit checks..."
+echo ""
+
+echo "📦 Building all packages..."
+cargo build --all-features
+echo "✅ Build successful"
+echo ""
+
+echo "🧹 Checking formatting..."
+cargo fmt --all -- --check
+echo "✅ Formatting check passed"
+echo ""
+
+echo "📎 Running clippy..."
+cargo clippy --all-targets --all-features -- -D warnings
+echo "✅ Clippy passed"
+echo ""
+
+echo "🧪 Running all tests..."
+cargo test --all-features
+echo "✅ All tests passed"
+echo ""
+
+echo "📚 Building documentation..."
+cargo doc --no-deps --all-features
+echo "✅ Documentation built"
+echo ""
+
+echo "✨ All checks passed! Safe to commit and push."
