Skip to content

Commit 735a7e4

Browse files
author
Chintan Patel
authored
Create contributing.md
1 parent c9d6e0e commit 735a7e4

1 file changed

Lines changed: 31 additions & 0 deletions

File tree

‎contributing.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Contributing
2+
3+
## Setup
4+
5+
```bash
6+
git clone https://github.com/Chintanpatel24/arrowcode.git
7+
cd arrowcode
8+
bun install
9+
bun run ci
10+
```
11+
12+
## Checks before PR
13+
14+
```bash
15+
bun run typecheck
16+
bun run test:smoke
17+
bun run src/index.ts --help
18+
bun run src/index.ts --banner
19+
```
20+
21+
## Guidelines
22+
23+
- Keep file tools sandboxed via `Workspace`
24+
- Prefer workspace-local session/checkpoint data over creating `~/.arrowcode` unless install/setup
25+
- No emoji in TUI output
26+
- Update `GUIDE.md` / `docs/` when adding commands or flows
27+
- Add smoke coverage for new critical paths when practical
28+
29+
## Layout
30+
31+
See [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md) and [GUIDE.md](GUIDE.md).

0 commit comments

Comments
 (0)