Skip to content

Conversation

Copilot
Copy link
Contributor

@Copilot Copilot AI commented Sep 23, 2025

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

  • Created agents.md - A new file that serves as the standard AI agent instruction file for the project
  • Adapted content structure - Transformed the original cursor rules (.mdc format) into a well-structured markdown document
  • Enhanced documentation - Expanded the original content with additional context about project structure, development workflow, and best practices

Key Features

The new agents.md file includes:

  • Project Overview - Clear description of the Apify CLI and its purpose
  • Command Development Guidelines - Step-by-step instructions for creating new CLI commands
  • Code Templates - Ready-to-use examples showing proper command structure
  • Import Patterns - Correct usage of ApifyCommand, Args, and Flags from the command framework
  • Naming Conventions - Standards for command naming (lowercase, dash-separated)
  • Registration Process - How to properly add commands to apifyCommands or actorCommands arrays
  • Development Workflow - Common development tasks like building, testing, and linting

Example Content

The file provides practical examples like this command template:

export class MyCommandCommand extends ApifyCommand<typeof MyCommandCommand> {
    static override name = "my-command" as const;
    
    static override description = "Description of what this command does";
    
    async run() {
        // Command logic implementation
    }
}

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.

Copy link
Contributor Author

Copilot AI commented Sep 23, 2025

@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.

@vladfrangu vladfrangu added the adhoc Ad-hoc unplanned task added during the sprint. label Sep 23, 2025
@Copilot Copilot AI changed the title [WIP] [Copilot test] Adapt cursor rules file to agents.md format Adapt cursor rules file to agents.md format Sep 23, 2025
@Copilot Copilot AI requested a review from vladfrangu September 23, 2025 13:09
Copilot finished work on behalf of vladfrangu September 23, 2025 13:09
@vladfrangu vladfrangu marked this pull request as ready for review September 23, 2025 13:15
@vladfrangu vladfrangu requested a review from B4nan as a code owner September 23, 2025 13:15
Copy link
Contributor

@janbuchar janbuchar left a 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"

@vladfrangu vladfrangu changed the title Adapt cursor rules file to agents.md format chore: Create agents.md file Sep 25, 2025
- Actor configuration uses `.actor/actor.json` (new format)
- Reference constants from `src/lib/consts.ts` for file paths and configurations

## Testing
Copy link
Contributor

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

Comment on lines +97 to +98
- Write tests for new commands following existing patterns in the `test/` directory
- Use the testing utilities and setup from the project
Copy link
Contributor

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

adhoc Ad-hoc unplanned task added during the sprint.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Copilot test] Adapt cursor rules file to agents.md format

3 participants