Skip to content

docs: add org-wide agent guidance - #48

Draft
joshschmelzle wants to merge 4 commits into
mainfrom
cursor/agent-guidance-57c0
Draft

joshschmelzle wants to merge 4 commits into
mainfrom
cursor/agent-guidance-57c0

Conversation

@joshschmelzle

@joshschmelzle joshschmelzle commented Oct 24, 2026 •

Copy link
Copy Markdown
Member

Why

Agents copy whatever repo they land in, including archived ones. Issue #26 asks for one org-wide guidance file that points at the existing docs. The root AGENTS.md is already local guidance for this docs repo, so the org file is agents/AGENTS.md and the root file only points at it.

What changed

  • Added agents/AGENTS.md (92 lines). Links are absolute GitHub URLs so a per-repo stub can point at the same file.

  • Root AGENTS.md keeps the local rules and links to the org file.

  • style/PYTHON.md states Python 3.13, not 3.14, not 3.15, and not 3.13+, and says the two files change together.

  • GETTING_STARTED.md says Python 3.13.

  • README.md indexes the new file.

  • agents/AGENTS.md carries the release rules from Land a Fix and Cut a Release (docs: leave the package version to the release pull request #49): fix PRs leave the version alone, a release PR sets it, 3.0 (native) with no Debian revision, check both wlanpi/dev and wlanpi/main, and pi-gen and the kernel follow their own rules. Recognizing Cruft lists a -1 revision on a new version and a version bump inside a fix PR.

Acceptance criteria from #26

Covered:

  • Authority model. The developers repo is the source of truth. Archived repos, legacy repos, and older suite branches do not override it.
  • Platform rule. Debian 13 Trixie, Python 3.13, system python3, no pyenv, conda, or uv interpreter. Not 3.14, not 3.15, not 3.13+.
  • Maintenance exception. Python 3.11 and 3.9 only on the matching suite branch or an existing-package fix.
  • Conventions as recommendations, with links to Contributing, Packaging, FHS, Python, README Standards, Git Workflow, Release Process, debchange, and licensing.
  • Recognizing Cruft at the pattern level, with no repo names.
  • A line that this platform rule and style/PYTHON.md change in the same commit.
  • No em dash, and -- only where a flag or URL needs it.
  • README index.
  • GETTING_STARTED.md and style/PYTHON.md match the 3.13 policy.
  • File length is 92 lines.

Adjusted on purpose:

  • The issue asks for AGENTS.md at the repo root. That path is already local guidance for editing this repo. The org file is agents/AGENTS.md. The root file points at it.
  • The issue's git bullets (a dev branch, u/<user> branches, merge commits from dev into main) are not copied. CONTRIBUTING.md on main says main is the long-lived branch and feature pull requests squash-merge. The guidance links that doc.
  • Systemd paths are not copied from the issue. architecture/FHS.md is the source for unit install paths.

Open for follow-up:

  • Run an agent tool on a sample task and confirm it avoids a cruft pattern.
  • Per-repo stub rollout, and the follow-up issue for that rollout. This pull request does not file that issue.
  • PACKAGING_EXAMPLE.md still has requires-python = ">=3.13". Left as it is.

Verification

  • Claims about branches, FHS paths, debhelper-compat (= 13), and Python style were checked against the files linked above.
  • shellcheck install.sh passed. actionlint passed. This change does not edit a workflow or a shell script.

Draft. Do not merge.

Open in Web Open in Cursor 

Root AGENTS.md stays local to this repo. The org file links the existing
docs and states the Trixie and Python 3.13 rule.

Co-authored-by: jsz <joshschmelzle@users.noreply.github.com>
@joshschmelzle joshschmelzle added the documentation Improvements or additions to documentation label Oct 24, 2026
@joshschmelzle joshschmelzle self-assigned this Oct 24, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant