🔧 Add AGENTS.md
#1083
Merged
🔧 Add AGENTS.md
#1083
Conversation
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
There was a problem hiding this comment.
Pull request overview
This PR adds an AGENTS.md file to provide guidance for AI coding agents working on the MyST-Parser repository, along with supporting tox environments for code quality tooling.
Changes:
- Added comprehensive
AGENTS.mddocumentation covering project structure, development workflows, architecture, and best practices - Added tox environments for ruff linting/formatting and mypy type checking
- Added dependency groups for mypy and ruff in
pyproject.toml
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| AGENTS.md | New comprehensive guide for AI agents with project overview, development commands, architecture documentation, and coding guidelines |
| tox.ini | Added ruff-check, ruff-fmt, and mypy test environments for code quality tooling |
| pyproject.toml | Added dependency groups for mypy and ruff with pinned versions |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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 PR adds an
AGENTS.mdfile to provide guidance for AI coding agents working on the MyST-Parser repository, along with supporting tox environments for code quality tooling.Changes:
AGENTS.mddocumentation covering project structure, development workflows, architecture, and best practicespyproject.toml