[RFC] docs: add Claude skills for operations/facts/tests conventions#1701
Open
maisim wants to merge 1 commit into
Open
[RFC] docs: add Claude skills for operations/facts/tests conventions#1701maisim wants to merge 1 commit into
maisim wants to merge 1 commit into
Conversation
Move detailed file-scoped conventions out of local-only AI configs and into tracked Claude skills under .claude/skills/, following the pattern proposed in upstream PR pyinfra-dev#1683: - writing-operations: operation patterns, _inner() composition, error handling - writing-facts: FactBase anatomy, parsing, multi-file marker pattern - writing-operation-tests: JSON/YAML fixture schema for tests/operations/ - writing-fact-tests: JSON/YAML fixture schema for tests/facts/ Also enrich AGENTS.md with a few items previously held only locally: - Command objects (StringCommand, QuoteString, MaskString, ...) - Connector data (connector_data_meta / host.connector_data) - Coverage gevent concurrency note - Pointer to pyinfra-dev-deploy for working with multiple PRs - Index of the new skills under "Detailed conventions"
Contributor
Author
|
@Fizzadar @wowi42 @DonDebonair we should keep all, part, or nothing, let me know I just did a complete reread and didn't find any major mistakes. 🤞 |
wowi42
added
documentation
Fizzadar
reviewed
May 18, 2026
| { | ||
| "args": [], | ||
| "kwargs": {}, | ||
| "exception": "OperationError" |
Member
There was a problem hiding this comment.
Exceptions look like (example):
"exception": {
"names": ["OperationValueError"],
"message": "'content' must be supplied when 'present' == True"
}| **Prefer YAML for new fixtures.** To cover a new code path, add a fixture — do not | ||
| write a new Python test. | ||
|
|
||
| ## Fixture schema (JSON) |
Member
There was a problem hiding this comment.
This schema + facts are duplicated in AGENTS.md as well which is likely to drift - we could point agents at each skill file? (Will non-claude harnesses handle that correctly?)
| ### `output` format | ||
|
|
||
| Each string is one line of stdout. Empty strings represent blank lines. | ||
| Use real command output whenever possible — copy from an actual system. |
Member
There was a problem hiding this comment.
Suggested change
| Use real command output whenever possible — copy from an actual system. | |
| Always use real command output — copy from an actual system. |
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
3 participants
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.
Move my detailed file-scoped conventions (copilot instructions) into tracked Claude skills under .claude/skills/, following the pattern proposed in upstream PR #1683:
Also enrich AGENTS.md with a few items previously held only locally:
3.xat this time)scripts/dev-test.sh)scripts/dev-lint.sh)