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.
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>
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": "28ccc915-c8b3-437b-a6de-cb3eb2b264d9",
"taskIndex": 0,
"request": "[original issue]\n**New Open SWE Request**\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\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\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 with Repository Guidelines",
"createdAt": 1752021048198,
"completed": false,
"planRevisions": [
{
"revisionIndex": 0,
"plans": [
{
"index": 0,
"plan": "Create a new file named `AGENTS.md` in the root of the repository.",
"completed": false
},
{
"index": 1,
"plan": "In `AGENTS.md`, add a section with the following content: 'When creating new functions, always first search in the root directory to see if one exists, and if not, create it in a new file. Use `ncc` to build the main script from `index.js`. Commonly executed scripts include the build script (`npm run build`). Note that the `test` script is a placeholder and does not run actual tests.'",
"completed": false
},
{
"index": 2,
"plan": "In `AGENTS.md`, add a section with the following content: 'The repository is structured with the main script in `index.js` and a compiled version in `dist/index.js`. The GitHub Action is defined in `action.yml`. The workflow for testing the action is located in `.github/workflows/test.yml`.'",
"completed": false
},
{
"index": 3,
"plan": "In `AGENTS.md`, add a section with the following content: 'Dependencies are managed via `package.json`. To install them, use `npm install`. Key dependencies include `node-fetch`, `@actions/core`, `@actions/exec`, `@actions/github`, and `execa`.'",
"completed": false
},
{
"index": 4,
"plan": "In `AGENTS.md`, add a section with the following content: 'Testing is configured in `.github/workflows/test.yml`, which runs on pushes to specific branches. The workflow uses the action to start a k3s cluster and runs `kubectl` commands to verify the setup. Note that the `test` script in `package.json` is a placeholder and does not execute tests.'",
"completed": false
}
],
"createdAt": 1752021048198,
"createdBy": "agent"
}
],
"activeRevisionIndex": 0
}
],
"activeTaskIndex": 0
}
debianmaster
