Skip to content

Commit 70e0e3f

Browse files
committed
docs: tighten oss onboarding and trim legacy cli alias
1 parent 90e5a87 commit 70e0e3f

7 files changed

Lines changed: 224 additions & 190 deletions

File tree

AGENTS.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,10 +46,10 @@ CLI input
4646
- `[` and `]` navigate hunks across the full review stream. Do not reintroduce `j`/`k` hunk navigation unless the user asks.
4747
- Agent context belongs beside the code, not hidden in a separate mode or workflow.
4848
- Agent notes are hunk-specific: show notes for the selected hunk, render them in the diff flow near the annotated row, and keep a clear spatial relationship to the code they explain.
49-
- When making code changes in this repo, also refresh `.hunk/latest.json` so the next review can load agent rationale with `hunk git --agent-context .hunk/latest.json`.
49+
- When making code changes in this repo, also refresh `.hunk/latest.json` so the next review can load agent rationale with `hunk diff --agent-context .hunk/latest.json`.
5050
- Keep `.hunk/latest.json` concise and review-oriented: one changeset summary, file summaries in narrative order, and a few hunk-level annotations with real rationale.
5151
- File order in `.hunk/latest.json` is intentional, but the visible note UI should stay hunk-note driven rather than showing generic file or changeset explainer cards.
52-
- If newly created files should appear in `hunk git` before commit, use `git add -N <paths>` so they show up in the review stream without staging content.
52+
- If newly created files should appear in `hunk diff` before commit, use `git add -N <paths>` so they show up in the review stream without staging content.
5353

5454
## commands
5555

CONTRIBUTING.md

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
# Contributing
2+
3+
Thanks for contributing to Hunk.
4+
5+
## Before you open a PR
6+
7+
- open an issue or discussion first for large behavior or UX changes
8+
- keep PRs focused
9+
- include tests for parser, CLI, or rendering changes where practical
10+
- update `README.md` when the public workflow changes
11+
- refresh `.hunk/latest.json` for local review context when you change code
12+
13+
## Development setup
14+
15+
```bash
16+
git clone https://github.com/modem-dev/hunk.git
17+
cd hunk
18+
bun install
19+
```
20+
21+
Run from source:
22+
23+
```bash
24+
bun run src/main.tsx -- diff
25+
```
26+
27+
## Validation
28+
29+
For most changes, run:
30+
31+
```bash
32+
bun run typecheck
33+
bun test
34+
```
35+
36+
For rendering or terminal interaction changes, also run:
37+
38+
```bash
39+
bun run test:tty-smoke
40+
```
41+
42+
If you touch packaging or release-related files, also run:
43+
44+
```bash
45+
bun run build:npm
46+
bun run check:pack
47+
```
48+
49+
## Pull request checklist
50+
51+
- [ ] scope is focused
52+
- [ ] tests or rationale added for behavior changes
53+
- [ ] `bun run typecheck` passes
54+
- [ ] `bun test` passes
55+
- [ ] `README.md` updated if the CLI or install flow changed
56+
57+
## Design notes
58+
59+
Hunk is review-first:
60+
61+
- the main pane is a single multi-file review stream
62+
- the sidebar is navigation, not a single-file mode switcher
63+
- split and stack views come from the same normalized diff model
64+
- agent notes should stay attached to the code they explain
65+
66+
## Code of conduct
67+
68+
Be respectful, assume good intent, and focus review on the code and user impact.

0 commit comments

Comments
 (0)