docs: add repo-local AGENTS.md with deterministic validation workflow guidance#4566
Closed
devin-ai-integration[bot] wants to merge 1 commit intomainfrom
Closed
docs: add repo-local AGENTS.md with deterministic validation workflow guidance#4566devin-ai-integration[bot] wants to merge 1 commit intomainfrom
devin-ai-integration[bot] wants to merge 1 commit intomainfrom
Conversation
… guidance Closes #4564 - Add AGENTS.md at repo root with contributor guidance for AI coding assistants - Document repository layout, environment setup, and workspace structure - Include deterministic validation workflow: ruff lint, ruff format, mypy, pytest - Define safety boundaries (secrets, VCR cassettes, network blocking, tests) - Document CI workflows, commit conventions, testing conventions, and code style - Add 22 regression tests validating AGENTS.md content (sections, commands, safety rules) Co-Authored-By: João <joao@crewai.com>
Contributor
Author
|
Prompt hidden (unlisted session) |
Contributor
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
Contributor
Author
|
Closing due to inactivity for more than 7 days. Configure here. |
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.
docs: add repo-local AGENTS.md with deterministic validation workflow guidance
Summary
Closes #4564.
Adds a repo-local
AGENTS.mdat the repository root to give AI coding assistants and contributors deterministic, machine-readable guidance for validating changes before opening PRs. This is distinct from the existinglib/crewai/src/crewai/cli/templates/AGENTS.mdtemplate (which is scaffolded into end-user projects viacrewai create).The file documents:
uv synccommands, Python version requirementAlso adds 22 parametrized regression tests (
lib/crewai/tests/test_agents_md.py) that validate the file exists and contains all required sections, validation commands, safety rules, and workspace member references.Review & Testing Checklist for Human
.github/workflows/linter.yml,tests.yml,type-checker.yml) andpyproject.tomlto confirm nothing is stale or misleadingtest_agents_md.pyusesPath(__file__).resolve().parents[3]to locate the repo root — confirm this resolves correctly in CI where test working directory may differ"Never commit secrets","Deterministic Validation Workflow"). Decide if this level of coupling is acceptable for catching future drift vs. being too brittle for section rewritesNotes
AGENTS.md(it's Markdown, not Python) — CI only lints changed.pyfiles so this won't affect the lint workflow.