Make repo AI-ready: AGENTS.md, CI, templates, changelog - #19
Merged
Conversation
- Add AGENTS.md with project overview, structure, conventions, and common pitfalls for AI coding agents. - Add Maintenance Matrix to .github/copilot-instructions.md mapping script changes to required companion updates. - Add .github/workflows/ci.yml (shellcheck on all .sh files) — this repo previously had no CI at all. - Add .github/workflows/copilot-setup-steps.yml to pre-install shellcheck for the Copilot cloud coding agent. - Add bug report / feature request issue forms and a PR template derived from the maintenance matrix checklist. - Add CHANGELOG.md (Keep a Changelog format) seeded from PR history. - Vendor the johnpapa/ai-ready skill into .github/skills/ai-ready/. Assisted by ai-ready v1.2.0 (https://github.com/johnpapa/ai-ready) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Default severity (style/info) failed on pre-existing SC2086/SC2317 info-level nits in scripts unrelated to this PR. Failing only on warning+ keeps CI meaningful without requiring an unrelated cleanup of every existing script as part of this PR. Co-authored-by: Copilot <223556219+Copilot@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
2 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.
Summary
Runs the ai-ready skill against this repo and fills in the missing AI-context, dev-workflow, and onboarding assets.
Added
AGENTS.md— project overview, structure, tech stack, conventions, common pitfalls.github/copilot-instructions.md.github/workflows/ci.yml— shellcheck on all.shfiles (repo had no CI before this).github/workflows/copilot-setup-steps.yml— installs shellcheck for Copilot's cloud coding agent.github/ISSUE_TEMPLATE/{bug_report,feature_request}.yml.github/PULL_REQUEST_TEMPLATE.mdCHANGELOG.md(Keep a Changelog format, seeded from merged PR history).github/skills/ai-ready/skill itselfSkipped (not needed for this repo)
.mcp.json— no external APIs/DBs/cloud services for the agent to integrate with; scripts run on remote Plesk servers, not against local dependencies.dependabot.yml— no package manifests/lockfiles in this repo to scan.docs/site — README + AGENTS.md + copilot-instructions.md are sufficient for a script collection this size (documented explicitly in AGENTS.md).Assisted by ai-ready v1.2.0