Create AGENTS.md Repository Guidelines Document

[megahirt]

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": "a55cbf38-6d79-40eb-b068-1eb863c94953", "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 with comprehensive development rules and context", "createdAt": 1756423137291, "completed": false, "planRevisions": [ { "revisionIndex": 0, "plans": [ { "index": 0, "plan": "Create the `AGENTS.md` file in the repository root with comprehensive guidelines covering general rules, repository structure, dependencies/installation, testing instructions, and pull request formatting. The file will include specific context about the multi-service architecture (backend .NET 9.0, frontend SvelteKit, FwLite MAUI app, platform.bible extension), Taskfile-based automation, development environment setup with Tilt + Kubernetes, testing frameworks (xUnit for backend, Playwright for E2E), package managers (pnpm for frontend, dotnet for backend), code formatting tools (EditorConfig, ESLint/Prettier), and service organization patterns. Each section will be wrapped in the required XML tags and contain actionable, concise guidelines for developers new to the repository.", "completed": false } ], "createdAt": 1756423137291, "createdBy": "agent" } ], "activeRevisionIndex": 0 } ], "activeTaskIndex": 0 } [ "Create the `AGENTS.md` file in the repository root with comprehensive guidelines covering general rules, repository structure, dependencies/installation, testing instructions, and pull request formatting. The file will include specific context about the multi-service architecture (backend .NET 9.0, frontend SvelteKit, FwLite MAUI app, platform.bible extension), Taskfile-based automation, development environment setup with Tilt + Kubernetes, testing frameworks (xUnit for backend, Playwright for E2E), package managers (pnpm for frontend, dotnet for backend), code formatting tools (EditorConfig, ESLint/Prettier), and service organization patterns. Each section will be wrapped in the required XML tags and contain actionable, concise guidelines for developers new to the repository." ]

[open-swe]

🟠 Plan Ready for Approval 🟠

I've generated a plan for this issue and it's ready for your review.

Plan: Create AGENTS.md repository guidelines document with comprehensive development rules and context

• Task 1:

Create the `AGENTS.md` file in the repository root with comprehensive guidelines covering general rules, repository structure, dependencies/installation, testing instructions, and pull request formatting. The file will include specific context about the multi-service architecture (backend .NET 9.0, frontend SvelteKit, FwLite MAUI app, platform.bible extension), Taskfile-based automation, development environment setup with Tilt + Kubernetes, testing frameworks (xUnit for backend, Playwright for E2E), package managers (pnpm for frontend, dotnet for backend), code formatting tools (EditorConfig, ESLint/Prettier), and service organization patterns. Each section will be wrapped in the required XML tags and contain actionable, concise guidelines for developers new to the repository.

Please review the plan and let me know if you'd like me to proceed, make changes, or if you have any feedback.

✅ Plan Accepted ✅

The proposed plan was accepted.

Plan: Create AGENTS.md repository guidelines document with comprehensive development rules and context

• Task 1:

Create the `AGENTS.md` file in the repository root with comprehensive guidelines covering general rules, repository structure, dependencies/installation, testing instructions, and pull request formatting. The file will include specific context about the multi-service architecture (backend .NET 9.0, frontend SvelteKit, FwLite MAUI app, platform.bible extension), Taskfile-based automation, development environment setup with Tilt + Kubernetes, testing frameworks (xUnit for backend, Playwright for E2E), package managers (pnpm for frontend, dotnet for backend), code formatting tools (EditorConfig, ESLint/Prettier), and service organization patterns. Each section will be wrapped in the required XML tags and contain actionable, concise guidelines for developers new to the repository.

Proceeding to implementation...