Skip to content

Commit 2bf121c

Browse files
m2declaude
andcommitted
Add CLAUDE.md with pre-push checklist and project conventions
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent d81aa13 commit 2bf121c

1 file changed

Lines changed: 26 additions & 0 deletions

File tree

CLAUDE.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# CLAUDE.md
2+
3+
## Pre-push checklist
4+
5+
Always run lint and tests before pushing anything:
6+
7+
```sh
8+
cargo fmt --check
9+
cargo clippy -- -D warnings
10+
cargo test
11+
```
12+
13+
## Project structure
14+
15+
- `src/` — Rust CLI source code
16+
- `providers/` — JSON recipe files for each API provider
17+
- `npm/` — npm package structure (shim + 5 platform packages)
18+
- `docs/` — Documentation site source (GitHub Pages)
19+
- `homebrew/` — Local copy of Homebrew formula (canonical copy lives in `m2de/homebrew-tap`)
20+
21+
## Release process
22+
23+
1. Update `version` in `Cargo.toml` and all 6 `npm/*/package.json` files
24+
2. Update `optionalDependencies` versions in `npm/getapi-cli/package.json`
25+
3. Commit and tag: `git tag vX.Y.Z && git push origin master --tags`
26+
4. The release workflow handles building, GitHub Release, crates.io, npm, and Homebrew tap

0 commit comments

Comments
 (0)