Add agents.md, fix error when comming that file#59
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
💡 Enable Vercel Agent with $100 free credit for automated AI reviews |
There was a problem hiding this comment.
Pull Request Overview
This PR adds documentation for coding agents and resolves a typo in the PR title. The main addition is an AGENTS.md file that provides comprehensive guidance for AI coding assistants working with this Saleor Payment App repository, including project structure, development commands, architecture details, and testing instructions.
Key Changes:
- Added comprehensive AGENTS.md documentation file with development guidelines and architecture overview
- Registered AGENTS.md in .gitallowed file
- Created CLAUDE.md reference file
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| AGENTS.md | New comprehensive documentation file providing coding agent guidance on project structure, commands, architecture, and payment flow testing |
| .gitallowed | Added AGENTS.md to the allowed files list |
| CLAUDE.md | Added reference to AGENTS.md |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| @@ -0,0 +1 @@ | |||
| AGENTS.md No newline at end of file | |||
There was a problem hiding this comment.
[nitpick] The file contains only a reference 'AGENTS.md' without context or explanation. Consider adding a brief description of the file's purpose, such as '# Agent Documentation\n\nSee AGENTS.md for guidance on working with this codebase.'
| AGENTS.md | |
| # Agent Documentation | |
| See [AGENTS.md](AGENTS.md) for guidance on working with this codebase. |
There was a problem hiding this comment.
yes, because git secrets hook was marking AGENTS file as breaking rules due to it's regex
3 participants
No description provided.