Skip to content

Commit c02668d

Browse files
authored
docs: stop the contributor first hour promising things that are not true (#1443)
1 parent 9fd34d0 commit c02668d

5 files changed

Lines changed: 33 additions & 11 deletions

File tree

.agents/skills/create-pr/SKILL.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,8 @@ the usual ones.
3131

3232
1. Work happens on a branch off `main`, named `<type>/<short-kebab-summary>`
3333
matching the commit type: `fix/hint-overlay-flicker`, `feat/hint-arrows`.
34-
2. Run the full gate — it is exactly what CI runs, so surprises surface here:
34+
2. Run the full gate — the same recipes CI gates on, run on your host only,
35+
where CI runs them on macOS, Linux and Windows:
3536

3637
```bash
3738
just ci

.github/pull_request_template.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,9 @@
4444
scan, build); CI runs them on macOS, Linux and Windows
4545
- [ ] Tests added/updated for new or changed functionality
4646
- [ ] Documentation updated (if applicable)
47-
- [ ] Commit messages follow [conventional commits](https://www.conventionalcommits.org/)
47+
- [ ] PR title is a [conventional commit](https://www.conventionalcommits.org/)
48+
subject written for users — this PR squash-merges, so the title is what
49+
Release Please ships in the changelog, not the commits on the branch
4850

4951
## Screenshots / Recordings
5052

CONTRIBUTING.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,9 @@ issues, so reports stay confidential.
4747

4848
Set up your environment by following
4949
[DEVELOPMENT.md](docs/DEVELOPMENT.md#development-setup) — Devbox is the
50-
recommended path and provides every tool pre-configured.
50+
recommended path and provides the toolchain pre-configured. On Linux, read the
51+
prerequisites there first: Devbox does not cover the system packages a CGO
52+
build links against.
5153

5254
---
5355

@@ -234,9 +236,7 @@ and don't submit changes you can't explain.
234236
235237
## Good First Contributions
236238
237-
Not sure where to start? Issues labeled
238-
[`good first issue`](https://github.com/y3owk1n/neru/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
239-
are curated to be well-scoped for newcomers. Beyond those:
239+
Not sure where to start? Any of these are welcome:
240240
241241
- 🐛 Bug fixes — check the [open issues](https://github.com/y3owk1n/neru/issues)
242242
- 📝 Documentation improvements or typo fixes

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -286,11 +286,11 @@ and pull requests are very welcome.
286286

287287
```bash
288288
git checkout -b feature/your-feature
289-
just ci # everything CI checks, locally
289+
just ci # the same recipes CI gates on, on your host only
290290
# open a pull request
291291
```
292292

293-
[Contributing Guide](CONTRIBUTING.md) · [Development Guide](docs/DEVELOPMENT.md) · [Good first issues](https://github.com/y3owk1n/neru/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
293+
[Contributing Guide](CONTRIBUTING.md) · [Development Guide](docs/DEVELOPMENT.md)
294294

295295
---
296296

docs/DEVELOPMENT.md

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,13 +43,21 @@ Then from a second terminal:
4343
./bin/neru hints # should show hint overlays
4444
```
4545

46+
> [!IMPORTANT]
47+
> On macOS this needs Accessibility permission granted to whichever app starts
48+
> the daemon — your terminal, when you run `./bin/neru launch` by hand. Without
49+
> it the smoke test reports an accessibility error instead of drawing overlays.
50+
> Same grant, same place as for the integration tests: see
51+
> [Running integration tests](#running-integration-tests).
52+
4653
There is no `just run` recipe — build first, then launch the daemon directly.
4754
The CLI talks to the running daemon over a socket, so both halves come from the
4855
same `./bin/neru` binary.
4956

5057
For end-user installation (Homebrew, Nix, prebuilt binaries) see
51-
[INSTALLATION.md](INSTALLATION.md); for preparing a Linux host see
52-
[LINUX_SETUP.md](LINUX_SETUP.md).
58+
[INSTALLATION.md](INSTALLATION.md); on Linux,
59+
[LINUX_SETUP.md](LINUX_SETUP.md) covers both preparing the host and the
60+
[build dependencies](LINUX_SETUP.md#build-dependencies) a source build needs.
5361

5462
---
5563

@@ -59,13 +67,17 @@ For end-user installation (Homebrew, Nix, prebuilt binaries) see
5967

6068
- **Go 1.26+**[Install Go](https://golang.org/dl/)
6169
- **Xcode Command Line Tools** (macOS) — `xcode-select --install`
70+
- **Build dependencies** (Linux) — the system `-dev`/`-devel` packages a CGO
71+
build links against, listed for apt, dnf and pacman in
72+
[LINUX_SETUP.md](LINUX_SETUP.md#build-dependencies). Install them before your
73+
first build, including under Devbox.
6274
- **Just** — command runner — [install](https://github.com/casey/just)
6375
- **golangci-lint** — linter — [install](https://golangci-lint.run/usage/install/)
6476

6577
### Option A: Devbox (recommended)
6678

6779
[Devbox](https://www.jetify.com/devbox) provides an isolated environment with
68-
every tool pre-configured:
80+
the toolchain below pre-configured:
6981

7082
```bash
7183
curl -fsSL https://get.jetify.com/devbox | bash
@@ -80,6 +92,13 @@ in the repo root takes over whenever you `cd` in.
8092
Devbox manages Go 1.26+, gopls, gotools, gofumpt, golines, golangci-lint, just,
8193
and clang-tools (for CGo).
8294

95+
On Linux it is not enough on its own: Devbox does not pull the `-dev` outputs a
96+
CGO build links against
97+
([jetify-com/devbox#2761](https://github.com/jetify-com/devbox/issues/2761)),
98+
so install the system packages listed in
99+
[LINUX_SETUP.md](LINUX_SETUP.md#build-dependencies) first — `just build` fails
100+
in the compiler without them.
101+
83102
### Option B: Manual installation
84103

85104
```bash

0 commit comments

Comments
 (0)