Repository navigation
chore: add AGENTS.md #6
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| # Agent instructions | ||
|
|
||
| *Regarding AI, adopt or get left behind...* | ||
|
|
||
| Working conventions for this repo, learned from the maintainer (Dennis K. | ||
| Paulsden) over prior sessions. This is about *how* to work here, not *what | ||
| the code does* — read the source and `docs/` for that. | ||
|
|
||
| ## Git workflow | ||
|
|
||
| - **AI will never commit.** Never run `git commit` (or `git add` in | ||
| service of one), no exceptions. The user commits their own work, always. | ||
| Make changes, verify them, and leave them in the working tree. | ||
| - **Never work on `main`.** Every change goes on a feature branch named | ||
| `P<priority>-<short-kebab-description>` (e.g. `P2-fix-inputcapture- | ||
| signal-path`). If no priority number was given, ask for one before | ||
| starting. | ||
| - **Any mention of "commit" from the user — "commit this," "one line | ||
| commit for each," anything — means produce the message text for them to | ||
| use, never run the command.** One line, Conventional Commits style | ||
| (`feat:`, `fix:`, `docs:`, `refactor:`, `test:`, `chore:`, …), no body. | ||
| - **A multi-repo or multi-file plan approved once is not standing | ||
| approval for the rest of it.** Do one repo (or one file, for something | ||
| like a README pass), stop, report what changed, and ask before doing the | ||
| next. This applies doubly to editing `README.md` specifically — ask | ||
| first even within one approved plan. | ||
|
|
||
| ## Verifying a change | ||
|
|
||
| CI (`.github/workflows/ci.yml`) is the reference for what "green" means | ||
| here: | ||
|
|
||
| ```sh | ||
| ruff check src tests | ||
| python -m mypy | ||
| python -m pytest -q -rs | ||
| ``` | ||
|
|
||
| Fix lint/format/type issues right the first time rather than looping | ||
| edit-check-edit-check; run the full gate once near the end of a change, not | ||
| after every edit. | ||
|
|
||
| ## Docs and changelog | ||
|
|
||
| `CHANGELOG.md`'s `[Unreleased]` section gets an entry for any user-facing | ||
| fix or feature, in the same voice as the existing entries (a bold one-line | ||
| summary, then the story: what broke, how it was found, what changed). | ||
|
|
||
| ## This repo's place in the family | ||
|
|
||
| python-libei is pyguitest's libei/eiinput dependency — a bug found while | ||
| working in pyguitest or pyguitest-recorder that traces back to input | ||
| injection or portal negotiation may actually belong here. Check whether a | ||
| fix on this side has a consequence for either sibling repo (a floor version | ||
| bump, a matching fix) before considering the work finished. | ||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
📐 Maintainability & Code Quality | 🟠 Major | ⚡ Quick win
Document the complete CI gate, or narrow the claim.
The three commands in this block are not the complete CI gate. The referenced workflow installs
.[dev]and nativelibeipackages, then also runs the no-native-library import job and the build/twine checkjob. Running only these commands can report a local pass while missing packaging and import-safety failures. Add those prerequisites and checks here, or describe this block as the core local checks rather than what “green” means for the repository. (raw.githubusercontent.com)🧰 Tools
🪛 LanguageTool
[uncategorized] ~30-~30: The official name of this software platform is spelled with a capital “H”.
Context: ...roved plan. ## Verifying a change CI (
.github/workflows/ci.yml) is the reference for...(GITHUB)
🤖 Prompt for AI Agents
Source: MCP tools