mirror of https://github.com/fabro-sh/fabro.git synced 2026-09-08 22:21:45 +00:00

Bryan Helmkamp 77d0cd265f Improve README features section and add CONTRIBUTING.md

Add emoji to feature bullets, update tagline, add human-in-the-loop
feature, highlight traceability in git checkpointing, remove system
requirements section, and link to new CONTRIBUTING.md instead of
CLAUDE.md.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

2026-03-10 15:16:03 -04:00

1.1 KiB

Raw Blame History

Contributing to Arc

Thanks for your interest in contributing to Arc!

Getting started

Prerequisites

Rust (latest stable)
Bun (for the web frontend)
Git

Build and test

# Build all Rust crates
cargo build --workspace

# Run all tests
cargo test --workspace

# Check formatting and lint
cargo fmt --check --all
cargo clippy --workspace -- -D warnings

Web frontend (arc-web)

cd apps/arc-web
bun install
bun run dev        # start dev server
bun test           # run tests
bun run typecheck  # type check

Development workflow

Fork the repository and create a branch from main
Make your changes
Ensure cargo test --workspace, cargo fmt --check --all, and cargo clippy --workspace -- -D warnings pass
Open a pull request

Reporting bugs

Open an issue on GitHub Issues with steps to reproduce the problem.

License

By contributing, you agree that your contributions will be licensed under the MIT License.

1.1 KiB Raw Blame History