mirror of
https://github.com/fabro-sh/fabro.git
synced 2026-09-14 23:22:51 +00:00
77d0cd265f
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>
50 lines
1.1 KiB
Markdown
50 lines
1.1 KiB
Markdown
# Contributing to Arc
|
|
|
|
Thanks for your interest in contributing to Arc!
|
|
|
|
## Getting started
|
|
|
|
### Prerequisites
|
|
|
|
- [Rust](https://rustup.rs/) (latest stable)
|
|
- [Bun](https://bun.sh/) (for the web frontend)
|
|
- Git
|
|
|
|
### Build and test
|
|
|
|
```bash
|
|
# 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)
|
|
|
|
```bash
|
|
cd apps/arc-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](https://github.com/brynary/arc/issues) with steps to reproduce the problem.
|
|
|
|
## License
|
|
|
|
By contributing, you agree that your contributions will be licensed under the [MIT License](LICENSE.md).
|