Skip to content

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
amir-yogev-gh:ai-ready-workflow
Open

Add AI-Ready workflow documentation and guidelines for creating or updating AGENTS.md files#10
amir-yogev-gh wants to merge 1 commit intoflightctl:mainfrom
amir-yogev-gh:ai-ready-workflow

Conversation

@amir-yogev-gh
Copy link
Copy Markdown
Collaborator

This pull request introduces a new ai-ready workflow for making projects AI-friendly by ensuring accurate AGENTS.md files 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

  • Added ai-ready/README.md to explain the purpose, usage, and directory structure of the AI-Ready workflow, including how it manages AGENTS.md and audits AI convention files.
  • Added ai-ready/SKILL.md as a workflow overview, outlining the process, quick start instructions, and example session for onboarding or updating a project for AI agents.

Guidelines and Principles

  • Introduced ai-ready/guidelines.md detailing core principles (accuracy, project-specificity, idempotency), safety rules, quality standards, and project integration guidance for the workflow.

Command and Skill Implementation

  • Added ai-ready/commands/update.md to define the /update command, which loads the guidelines and executes the update skill, optionally taking arguments for targeted updates.
  • Added ai-ready/skills/update.md providing a detailed, step-by-step process for discovering current state, analyzing the codebase, creating/updating AGENTS.md, auditing AI convention files, validating changes, and reporting results.

@amir-yogev-gh amir-yogev-gh requested a review from adalton March 23, 2026 11:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant