docs: add root AGENTS.md entry point#1419
Open
omribz156 wants to merge 2 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Adds a root-level AGENTS.md entry point for AI coding agents and updates .gitignore so the file can be committed, pointing agents to existing area-specific instruction docs.
Changes:
- Added root
AGENTS.mdwith concise top-level agent workflow and CI guardrails - Linked to existing
.github/instructions/*.instructions.mdfor detailed rules by area - Removed
AGENTS.mdfrom.gitignoreto allow committing the new entry point
Reviewed changes
Copilot reviewed 1 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| AGENTS.md | Introduces the root agent entry point and links to detailed instruction files |
| .gitignore | Stops ignoring AGENTS.md so it can be tracked in Git |
| uv run apm --version | ||
| ``` | ||
|
|
||
| ## Before Opening A PR |
Author
There was a problem hiding this comment.
Fixed in a734cb0: changed the heading to Before Opening a PR. Verified with ASCII and git diff --check.
| - Keep source files and CLI output printable ASCII. Do not add emoji, box drawing, curly quotes, or en/em dashes. | ||
| - Do not write YAML with direct `yaml.dump()` or `yaml.safe_dump()` calls to file handles outside `src/apm_cli/utils/yaml_io.py`; use `yaml_io.dump_yaml()`. | ||
| - Do not use `str(path.relative_to(base))`; use `portable_relpath()` from `apm_cli.utils.paths`. | ||
| - Keep new Python source files below the current CI file-length guardrail. |
Author
There was a problem hiding this comment.
Fixed in a734cb0: the guardrail now points to .github/workflows/ci.yml and names MAX_LINES=2450 so agents can validate it locally. Verified with ASCII and git diff --check.
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.
Description
Adds the missing root
AGENTS.mdentry point for coding agents and stops ignoring that file in.gitignoreso it can be committed.The new file keeps the top-level guidance concise and points agents to the existing
.github/instructions/*.instructions.mdfiles for detailed area-specific rules.Fixes #695
Type of change
Testing
Verification run:
AGENTS.mdcontains printable ASCII only.portable_relpath()grep guards.git diff --check -- .gitignore AGENTS.md.I did not run the full Python test suite because this is a docs-only change.
Implemented with Codex assistance; I kept the patch focused and manually reviewed the final diff.