Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
62 lines (41 loc) · 1.22 KB

CONTRIBUTING.md

File metadata and controls

62 lines (41 loc) · 1.22 KB
Raw

Contributing to aicx

Thanks for your interest in contributing to aicx.

Prerequisites

  • Rust 1.85+ with cargo
  • Git

Development

Install the repo-local Git hooks:

make git-hooks

Build the release binary:

cargo build --release

Run the linter (must pass with zero warnings):

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

Run tests:

cargo test

Local development commands that read or write tempfile-backed /tmp paths now follow the same path-safety policy as release builds. Export AICX_ALLOW_TMP=1 when you intentionally run dev/smoke commands against /tmp or macOS /private/var/folders paths. Cargo tests keep their cfg(test) tempfile allowance.

Format code:

cargo fmt

Pull Request Process

  1. Fork the repository.
  2. Create a feature branch from develop.
  3. Make your changes and ensure all checks pass (clippy, test, fmt).
  4. Open a pull request against the develop branch.
  5. Describe what your change does and why.

Code of Conduct

This project follows the Contributor Covenant Code of Conduct.

Vibecrafted with AI Agents by Vetcoders (c)2026 Vetcoders