Add AI scaffolding#61
Open
cwilkers wants to merge 6 commits into
Open
Conversation
* Borrowed Claude /init output to fill out README.md * Followed Tier 1 advice from "Repository Scaffolding for AI Coding Agents" to avoid extra tokenizing costs while providing a quick loop test harness for the agent to use. * Added linting for yaml, adoc, and json so AI agents can easily verify any changes they make
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
1 participant
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.
In the spirit of efficient use of AI, this PR adds an
AGENTS.mdfile with very basic instructions for an AI agent to use when assisting with changes to the repository.The main push was to add linting for the various document and conf file types involved, asciidoc, yaml, json, and Dockerfile, then equip an AI agent with instructions to use those to validate any changes made to the repo before creating a PR.
After a first pass with the linters, some non-structural changes were made to relevant files, mostly removing end of line whitespace and adding newlines at the end of files, with the occasional breakup of long lines.