Skip to content

Add AGENTS.md for AI coding agent guidance#6

Closed
Copilot wants to merge 2 commits intomainfrom
copilot/create-agents-documentation
Closed

Add AGENTS.md for AI coding agent guidance#6
Copilot wants to merge 2 commits intomainfrom
copilot/create-agents-documentation

Conversation

Copy link
Copy Markdown

Copilot AI commented Feb 11, 2026

Creates operational documentation for AI coding agents working in this GitHub Copilot workshop repository.

Changes

  • AGENTS.md (181 lines) — Comprehensive agent instructions including:

    • Executable commands for development (uvicorn src.app:app --reload), testing (pytest), and validation
    • Code style patterns with FastAPI-specific examples (type hints, HTTPException usage, in-memory storage constraint)
    • Three-tier boundary system (✅ safe / ⚠️ ask / 🚫 never) protecting workshop infrastructure
    • Workshop context explaining 5-step learning progression and automated validation
    • NOS Culture alignment mapping workshop goals to organizational principles
  • CLAUDE.md — Symlink to AGENTS.md for Claude-based agent compatibility

Key Constraints Documented

# ✅ Always safe - FastAPI validation pattern
def signup_for_activity(activity_name: str, email: str):
    if activity_name not in activities:
        raise HTTPException(status_code=404, detail="Activity not found")
    if email in activity["participants"]:
        raise HTTPException(status_code=400, detail="Student is already signed up")

# 🚫 Never - in-memory storage is intentional for workshop simplicity
# Don't add database layers or persistence

Workshop-specific boundaries prevent agents from modifying .github/workflows/ (breaks step validation), .github/steps/ (instructional content), or replacing in-memory storage (pedagogical choice).


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Co-authored-by: calexandre <1485193+calexandre@users.noreply.github.com>
Copilot AI changed the title [WIP] Add agents.md documentation file Add AGENTS.md for AI coding agent guidance Feb 11, 2026
Copilot AI requested a review from calexandre February 11, 2026 17:05
@calexandre calexandre closed this Feb 13, 2026
@calexandre calexandre deleted the copilot/create-agents-documentation branch February 24, 2026 14:11
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.

2 participants