-
Notifications
You must be signed in to change notification settings - Fork 35
chore: Create agents.md file #917
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Conversation
@vladfrangu 👋 This repository doesn't have Copilot instructions. With Copilot instructions, I can understand the repository better, work faster and produce higher quality PRs. I can generate a .github/copilot-instructions.md file for you automatically. Click here to open a pre-filled issue and assign it to me. I'll write the instructions, and then tag you for review. |
Co-authored-by: vladfrangu <[email protected]>
Removed examples section and updated documentation notes.
cdc173a
to
58d59f8
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- please make the title conform to the conventional commits spec
- at this point, the repository does not have any cursor rules - what is the PR adapting? I would instead say something like "introduce an agents.md file"
- Actor configuration uses `.actor/actor.json` (new format) | ||
- Reference constants from `src/lib/consts.ts` for file paths and configurations | ||
|
||
## Testing |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should explain feature tests here
- Write tests for new commands following existing patterns in the `test/` directory | ||
- Use the testing utilities and setup from the project |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's describe this in concrete words so that the agent doesn't have to re-analyze the project every time
This PR adapts the cursor rules file from PR #829 to the standard
agents.md
format, providing comprehensive guidance for AI agents working on the Apify CLI project.Changes Made
agents.md
- A new file that serves as the standard AI agent instruction file for the projectKey Features
The new
agents.md
file includes:ApifyCommand
,Args
, andFlags
from the command frameworkapifyCommands
oractorCommands
arraysExample Content
The file provides practical examples like this command template:
This maintains all the valuable guidance from the original cursor rules while making it more accessible and comprehensive for AI agents working on the codebase.
Fixes #916.
💡 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.