Skip to content

Create AGENTS.md Repository Guidelines Document #2

@CoreyTrombley

Description

@CoreyTrombley

You're given a task to write a collection of rules, context and guidelines on the repository you're provided. Please gather context on the following categories, then write an AGENTS.md file in the root of the repository.

  • General Rules: These are general rules any developer/agent should follow when writing code. It should contain rules such as "When creating new XYZ functions, always first search in the XYZ/ directory to see if one exists, and if not, create it and place it in an existing or new file". Additionally, here is where you'd include context about scripts which are commonly executed, such as linter and formatter scripts.
  • Repository Structure: This section is where you'll include high level context about how the repository is laid out, any highly useful and not overly obvious information about how the directories/files are structured, different apps/packages/services inside the repository, etc. Do not include every last detail about the repository contents, only a high level technical overview on the repository structure.
  • Dependencies and Installation: This section should include high level context about how to install dependencies, where to install them, package managers, etc. Do not include overly verbose context in this section as most repositories typically have straightforward dependency management.
  • Testing Instructions: A general guide on testing in this repository. It should include context such as testing frameworks, roughly what types of modules should be tested, how to run tests, and any other context a developer wouldn't be able to infer by looking at test files on how to write & run tests. Do not include every last detail about testing in this section, only the most used/important context necessary to run tests.
  • Pull request formatting: Rules and guidelines around how to format pull request titles and descriptions. This should only be populated if you find specific instructions in the repository around how to format pull request titles and descriptions. If the repository does not have specific instructions, leave this section empty. The agent will already generate well thought out titles and descriptions, so unless there are special rules specific to this repository, leave this section empty.

Ensure each category is properly wrapped in opening and closing XML tags. The tags to use are as follows:
<general_rules>
</general_rules>
<repository_structure>
</repository_structure>
<dependencies_and_installation>
</dependencies_and_installation>
<testing_instructions>
</testing_instructions>
<pull_request_formatting>
</pull_request_formatting>

It is incredibly important that you ALWAYS wrap your sections in the opening and closing XML tags. Failure to do so will result in an invalid file and will not be accepted.

The file should not contain any other content besides those tags, and the rules/context/instructions they contain. Ensure your rules are thoughtful, concise and actually useful to a developer who's never contributed to the repository before. You can think of it as a more structured and directed CONTRIBUTING.md file.

With all of this in mind, please explore the repository and write this single AGENTS.md file with the rules/context/instructions gathered!

Agent Context { "tasks": [ { "id": "68089008-f6e4-408f-9d47-862d47f842de", "taskIndex": 0, "request": "[original issue]\n**Create AGENTS.md Repository Guidelines Document**\nYou're given a task to write a collection of rules, context and guidelines on the repository you're provided. Please gather context on the following categories, then write an `AGENTS.md` file in the root of the repository.\n\n- **General Rules**: These are general rules any developer/agent should follow when writing code. It should contain rules such as \"When creating new XYZ functions, always first search in the XYZ/ directory to see if one exists, and if not, create it and place it in an existing or new file\". Additionally, here is where you'd include context about scripts which are commonly executed, such as linter and formatter scripts.\n- **Repository Structure**: This section is where you'll include high level context about how the repository is laid out, any highly useful and not overly obvious information about how the directories/files are structured, different apps/packages/services inside the repository, etc. Do not include every last detail about the repository contents, only a high level technical overview on the repository structure.\n- **Dependencies and Installation**: This section should include high level context about how to install dependencies, where to install them, package managers, etc. Do not include overly verbose context in this section as most repositories typically have straightforward dependency management. \n- **Testing Instructions**: A general guide on testing in this repository. It should include context such as testing frameworks, roughly what types of modules should be tested, how to run tests, and any other context a developer wouldn't be able to infer by looking at test files on how to write & run tests. Do not include every last detail about testing in this section, only the most used/important context necessary to run tests.\n- **Pull request formatting**: Rules and guidelines around how to format pull request titles and descriptions. This should only be populated if you find specific instructions in the repository around how to format pull request titles and descriptions. If the repository does not have specific instructions, leave this section empty. The agent will already generate well thought out titles and descriptions, so unless there are special rules specific to this repository, leave this section empty.\n\nEnsure each category is properly wrapped in opening and closing XML tags. The tags to use are as follows:\n\n\n\n\n\n\n\n\n\n\n\nIt is incredibly important that you ALWAYS wrap your sections in the opening and closing XML tags. Failure to do so will result in an invalid file and will not be accepted.\n\nThe file should not contain any other content besides those tags, and the rules/context/instructions they contain. Ensure your rules are thoughtful, concise and actually useful to a developer who's never contributed to the repository before. You can think of it as a more structured and directed `CONTRIBUTING.md` file.\n\nWith all of this in mind, please explore the repository and write this single `AGENTS.md` file with the rules/context/instructions gathered!", "title": "Create AGENTS.md Repository Guidelines Document for the Weekly Task Scheduler CLI Tool", "createdAt": 1754542537727, "completed": false, "planRevisions": [ { "revisionIndex": 0, "plans": [ { "index": 0, "plan": "Create the AGENTS.md file in the root directory with the required XML-tagged sections. Include comprehensive guidelines for developers based on the repository structure and practices observed.", "completed": true, "summary": "Successfully created the AGENTS.md file in the root directory with all required XML-tagged sections. The file includes comprehensive guidelines for developers based on thorough exploration of the repository structure and practices.\n\n**Key accomplishments:**\n- Created AGENTS.md with proper XML tags: ``, ``, ``, ``, and ``\n- Analyzed the repository structure, including the main `tasks` executable script, `setup-cron.sh`, configuration files, and dependencies\n- Documented general rules emphasizing code style maintenance, proper use of data persistence functions, and preservation of the task data structure\n- Provided high-level repository structure overview explaining the flat directory layout and key file purposes\n- Outlined the Node.js dependency installation process, including making scripts executable and email configuration\n- Described the manual testing approach since no automated testing framework exists\n- Left pull request formatting section empty as no specific requirements were found beyond standard practices\n\nThe guidelines are concise, technically accurate, and provide essential context for developers new to the repository, covering all aspects from code style to testing procedures." }, { "index": 1, "plan": "In the `` section, include guidelines about code style, task script usage, and file modifications. Mention the importance of maintaining the existing code structure and format.", "completed": false }, { "index": 2, "plan": "In the `` section, provide a high-level overview of the repository layout, explaining the purpose of key files and how they interact.", "completed": false }, { "index": 3, "plan": "In the `` section, outline the Node.js dependencies, installation process, and environment configuration steps.", "completed": false }, { "index": 4, "plan": "In the `` section, describe the manual testing approach used in this repository based on the README instructions.", "completed": false }, { "index": 5, "plan": "Leave the `` section with minimal content as there are no specific formatting requirements beyond standard practices mentioned in the README.", "completed": false }, { "index": 6, "plan": "Review the completed AGENTS.md file to ensure all required XML tags are properly included and the content is concise, useful, and follows the repository's existing practices.", "completed": false } ], "createdAt": 1754542537727, "createdBy": "agent" } ], "activeRevisionIndex": 0, "pullRequestNumber": 4 } ], "activeTaskIndex": 0 } [ "Create the AGENTS.md file in the root directory with the required XML-tagged sections. Include comprehensive guidelines for developers based on the repository structure and practices observed.", "In the `` section, include guidelines about code style, task script usage, and file modifications. Mention the importance of maintaining the existing code structure and format.", "In the `` section, provide a high-level overview of the repository layout, explaining the purpose of key files and how they interact.", "In the `` section, outline the Node.js dependencies, installation process, and environment configuration steps.", "In the `` section, describe the manual testing approach used in this repository based on the README instructions.", "Leave the `` section with minimal content as there are no specific formatting requirements beyond standard practices mentioned in the README.", "Review the completed AGENTS.md file to ensure all required XML tags are properly included and the content is concise, useful, and follows the repository's existing practices." ]

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions