Add AI-Ready workflow documentation and guidelines for creating or updating AGENTS.md files#10
Open
amir-yogev-gh wants to merge 1 commit intoflightctl:mainfrom
Open
Conversation
…dating AGENTS.md files
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
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 introduces a new
ai-readyworkflow for making projects AI-friendly by ensuring accurateAGENTS.mdfiles and auditing AI convention files. It provides clear documentation, guidelines, and a step-by-step skill for scanning, updating, and validating project instructions for AI coding agents. The workflow emphasizes accuracy, project-specificity, and safety, and is designed to be idempotent and minimally invasive.Key changes include:
Documentation and Workflow Overview
ai-ready/README.mdto explain the purpose, usage, and directory structure of the AI-Ready workflow, including how it managesAGENTS.mdand audits AI convention files.ai-ready/SKILL.mdas a workflow overview, outlining the process, quick start instructions, and example session for onboarding or updating a project for AI agents.Guidelines and Principles
ai-ready/guidelines.mddetailing core principles (accuracy, project-specificity, idempotency), safety rules, quality standards, and project integration guidance for the workflow.Command and Skill Implementation
ai-ready/commands/update.mdto define the/updatecommand, which loads the guidelines and executes the update skill, optionally taking arguments for targeted updates.ai-ready/skills/update.mdproviding a detailed, step-by-step process for discovering current state, analyzing the codebase, creating/updatingAGENTS.md, auditing AI convention files, validating changes, and reporting results.