Repository navigation
docs: add org-wide agent guidance - #48
Draft
joshschmelzle wants to merge 4 commits into
Draft
joshschmelzle wants to merge 4 commits into
joshschmelzle wants to merge 4 commits into
Conversation
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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.mdis already local guidance for this docs repo, so the org file isagents/AGENTS.mdand 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.mdkeeps the local rules and links to the org file.style/PYTHON.mdstates Python 3.13, not 3.14, not 3.15, and not3.13+, and says the two files change together.GETTING_STARTED.mdsays Python 3.13.README.mdindexes the new file.agents/AGENTS.mdcarries 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 bothwlanpi/devandwlanpi/main, and pi-gen and the kernel follow their own rules. Recognizing Cruft lists a-1revision on a new version and a version bump inside a fix PR.Acceptance criteria from #26
Covered:
python3, no pyenv, conda, or uv interpreter. Not 3.14, not 3.15, not3.13+.style/PYTHON.mdchange in the same commit.--only where a flag or URL needs it.GETTING_STARTED.mdandstyle/PYTHON.mdmatch the 3.13 policy.Adjusted on purpose:
AGENTS.mdat the repo root. That path is already local guidance for editing this repo. The org file isagents/AGENTS.md. The root file points at it.devbranch,u/<user>branches, merge commits fromdevintomain) are not copied.CONTRIBUTING.mdonmainsaysmainis the long-lived branch and feature pull requests squash-merge. The guidance links that doc.architecture/FHS.mdis the source for unit install paths.Open for follow-up:
PACKAGING_EXAMPLE.mdstill hasrequires-python = ">=3.13". Left as it is.Verification
debhelper-compat (= 13), and Python style were checked against the files linked above.shellcheck install.shpassed.actionlintpassed. This change does not edit a workflow or a shell script.Draft. Do not merge.