Refactor documentation and templates for AI coding agents #112
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.
This pull request makes several documentation and workflow improvements to the repository, focusing on refining guidance for AI coding agents, updating templates, and improving clarity for security and workflow operations. The most significant changes are a complete rewrite of
AGENTS.mdto provide more actionable and strict guidelines for AI-generated code, removal of redundant copilot instructions, and updates to security and workflow templates.AI Agent and Contributor Guidance:
AGENTS.mdto provide comprehensive, actionable guidelines for AI coding agents, including hard rules, coding patterns, error handling, parameter validation, testing requirements, CI/CD expectations, and an AI-friendly function template. The new document emphasizes production-readiness, maintainability, and auditability..github/copilot-instructions.mdtto consolidate and avoid duplication of AI agent guidance, with all relevant information now inAGENTS.md.Workflow and Template Updates:
run-nameto.github/workflows/bootstrap-repo.ymlfor clearer workflow identification in GitHub Actions runs..github/PULL_REQUEST_TEMPLATE.mdto suggest using GitHub Copilot for generating PR descriptions, improving contributor experience.Security Documentation:
.github/SECURITY.mdinstructions to clarify the process for reporting vulnerabilities, updating navigation to use "Advisories" and "New draft security advisory".