diff --git a/AGENTS.md b/AGENTS.md index 6c27bc1e0e..aedb054165 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -14,7 +14,7 @@ Linux: `qmake && make` (use `qmake-qt5` on Fedora). Headless server: `qmake "CON macOS: `qmake QMAKE_APPLE_DEVICE_ARCHS=arm64 QT_ARCH=arm64 -spec macx-xcode Jamulus.pro` (Use `x86_64` on Intel Macs; `macx-clang` if using `make`). Then `xcodebuild build`, and `macdeployqt ./{Debug,Release}/Jamulus.app`. -**Testing:** run headless server (args `-s -n`), connect a client (e.g. via: `-n -c localhost`; may need jackd running on Linux. Run dummy Jack via: `jackd -d dummy`), exercise the change; use the JSON-RPC API (`docs/JSON-RPC.md`) where possible. State what you tested in the PR with evidence. GitHub Actions builds multiple platforms — on failure read the failing step's log. +**Testing:** run headless server (args `-s -n`), connect a client (e.g. via: `-n -c localhost`; may need jackd running on Linux. Run dummy Jack via: `jackd -d dummy`), exercise the change; use the JSON-RPC API (`docs/JSON-RPC.md`) where possible. Connecting a client needs the plain `qmake && make` build — a `serveronly` binary rejects `-c`. State what you tested in the PR with evidence. GitHub Actions builds multiple platforms — on failure read the failing step's log. ## Never Do @@ -59,10 +59,10 @@ macOS: `qmake QMAKE_APPLE_DEVICE_ARCHS=arm64 QT_ARCH=arm64 -spec macx-xcode Jamu ## PR expectations -- One logical change per PR — no unrelated cleanup or reformatting of untouched code. Discuss features in an issue before implementing. See `CONTRIBUTING.md`. +- No unrelated cleanup or reformatting of untouched code. Discuss features in an issue before implementing. - Branch names starting with `autobuild` trigger CI builds on your fork. - Follow `.github/pull_request_template.md`. Include `CHANGELOG:` line. Add `AUTOBUILD: Please build all targets` for skipped targets (iOS, Windows JACK, Linux armhf/arm64) if touched; see `.github/workflows/autobuild.yml`. -- Builds? Tested? Smallest change possible? Self reviewed against "Priority order" above? +- Self reviewed against "Priority order" above? - Disclose AI-generated text at the end of Comments/PRs. (e.g: `> 🤖 Used AI: , `) — never in code comments. ## Read when relevant diff --git a/docs/agents/COMMENTING.md b/docs/agents/COMMENTING.md index 8e90a93a2c..75ba5aa138 100644 --- a/docs/agents/COMMENTING.md +++ b/docs/agents/COMMENTING.md @@ -4,4 +4,4 @@ - Comment only when you add evidence or an answer the thread lacks, in the shortest form that carries it; wait out an active human exchange, re-read the thread just before posting — it may have moved while you drafted — and treat a maintainer's stated preference about engagement as the rule. - If a posted comment proves wrong or incomplete, edit it in place so the error leaves the page; new evidence on the same finding also belongs in the existing comment, not a new one. - Open a new issue only for a defect you can reproduce, with the reproduction in the body; open a new PR only after a maintainer has agreed the change is wanted; leave starting discussions to humans. -- Disclose AI-generated text +- Disclose AI-generated text — the form is in `AGENTS.md`, PR expectations.