scriptoriumadmin/fabro
1
0
Fork 0
mirror of https://github.com/fabro-sh/fabro.git synced 2026-08-28 05:27:41 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4
fabro/CONTRIBUTING.md
Bryan Helmkamp 5b18680d57 fix remaining arc references in README, CONTRIBUTING, docs-internal 
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-03-12 12:28:04 -04:00

1.1 KiB
Raw Permalink Blame History

Contributing to Fabro

Thanks for your interest in contributing to Fabro!

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 (fabro-web)

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

Development workflow

  1. Fork the repository and create a branch from main
  2. Make your changes
  3. Ensure cargo test --workspace, cargo fmt --check --all, and cargo clippy --workspace -- -D warnings pass
  4. 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.