Skip to content

Create AGENTS.md Repository Guidelines Document #1

@tundakk

Description

@tundakk

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": "05a18f77-14e4-4d93-98ea-4acbe7e32bc9", "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": 1755368953073, "completed": true, "planRevisions": [ { "revisionIndex": 0, "plans": [ { "index": 0, "plan": "**Create the AGENTS.md file** in the root directory `/home/daytona/LaundrySystem.Backend/AGENTS.md` with comprehensive guidelines covering all required sections. The file must include:\n\n- **General Rules section** with development patterns including: always check existing Controllers/Implementations, Services/Interfaces, Services/Implementations, and Repos directories before creating new components; use Python generation scripts (`generate_controllers.py`, `generate_bll_files.py`, `generate_repos.py`) for standardized boilerplate; follow naming convention Entity -> EntityModel -> IEntityService -> EntityService -> IEntityRepo -> EntityRepo; use Guid primary keys; wrap responses in ServiceResponse; configure Mapster mappings in MappingConfig.cs; register services in ServiceCollectionExtensions.cs; use async/await patterns; enable nullable reference types; generate XML documentation\n\n- **Repository Structure section** describing the clean architecture with 4 main projects: LaundrySystem.Api (controllers, mappings, startup), LaundrySystem.BLL (services, integrations, DI), LaundrySystem.DAL (EF DbContext, repositories, migrations), LaundrySystem.Domain.Model (entities, models, responses); test projects using NUnit; Python code generation scripts; Media directory for assets\n\n- **Dependencies and Installation section** covering .NET 8.0 SDK requirement, NuGet package management with `dotnet restore`, SQL Server with Entity Framework Core, external services (Twilio SMS, Brevo/SendGrid email), key packages (EF Core, Identity, Mapster, JWT, Swagger), build with `dotnet build` and run with `dotnet run --project LaundrySystem.Api`\n\n- **Testing Instructions section** explaining NUnit framework usage, test project naming convention [ProjectName].Tests, run tests with `dotnet test`, focus on BLL and DAL layer testing, use coverlet.collector for coverage, follow NUnit [SetUp] and [Test] attributes, mock external dependencies, use separate test database for integration tests\n\n- **Pull Request Formatting section** left empty as no specific repository rules were found\n\nEach section must be properly wrapped in the required XML tags: ``, ``, ``, ``, ``", "completed": true, "summary": "Successfully created the AGENTS.md file in the root directory with comprehensive repository guidelines. The file includes all required sections properly wrapped in XML tags:\n\n**General Rules**: Documented development patterns including checking existing directories before creating new components, using Python generation scripts for standardized boilerplate code, following the Entity->EntityModel->IEntityService->EntityService->IEntityRepo->EntityRepo naming convention, using Guid primary keys, wrapping responses in ServiceResponse, configuring Mapster mappings, registering services in ServiceCollectionExtensions.cs, using async/await patterns, enabling nullable reference types, and generating XML documentation.\n\n**Repository Structure**: Described the clean architecture with 4 main projects - LaundrySystem.Api (controllers, mappings, startup), LaundrySystem.BLL (services, integrations, DI), LaundrySystem.DAL (EF DbContext, repositories, migrations), LaundrySystem.Domain.Model (entities, models, responses), along with test projects using NUnit, Python code generation scripts, and Media directory for assets.\n\n**Dependencies and Installation**: Covered .NET 8.0 SDK requirement, NuGet package management with `dotnet restore`, SQL Server with Entity Framework Core, external services (Twilio SMS, Brevo/SendGrid email), key packages (EF Core, Identity, Mapster, JWT, Swagger), and build/run commands.\n\n**Testing Instructions**: Explained NUnit framework usage, test project naming convention [ProjectName].Tests, running tests with `dotnet test`, focusing on BLL and DAL layer testing, using coverlet.collector for coverage, following NUnit [SetUp] and [Test] attributes, mocking external dependencies, and using separate test database configurations.\n\n**Pull Request Formatting**: Left empty as no specific repository rules were found during exploration.\n\nThe guidelines are comprehensive, concise, and provide essential context for developers new to the repository, covering the unique aspects of this clean architecture .NET project with its code generation patterns and standardized development practices." } ], "createdAt": 1755368953073, "createdBy": "agent" } ], "activeRevisionIndex": 0, "pullRequestNumber": 2, "completedAt": 1755369068343, "summary": "I've successfully created the AGENTS.md file in the LaundrySystem.Backend repository root, providing comprehensive guidelines for developers. The document covers general rules, repository structure, dependencies and installation, testing instructions, and pull request formatting, all wrapped in the required XML tags. The guidelines reflect the project's clean architecture, .NET 8.0 framework, and unique code generation patterns." } ], "activeTaskIndex": 0 } [ "**Create the AGENTS.md file** in the root directory `/home/daytona/LaundrySystem.Backend/AGENTS.md` with comprehensive guidelines covering all required sections. The file must include:\n\n- **General Rules section** with development patterns including: always check existing Controllers/Implementations, Services/Interfaces, Services/Implementations, and Repos directories before creating new components; use Python generation scripts (`generate_controllers.py`, `generate_bll_files.py`, `generate_repos.py`) for standardized boilerplate; follow naming convention Entity -> EntityModel -> IEntityService -> EntityService -> IEntityRepo -> EntityRepo; use Guid primary keys; wrap responses in ServiceResponse; configure Mapster mappings in MappingConfig.cs; register services in ServiceCollectionExtensions.cs; use async/await patterns; enable nullable reference types; generate XML documentation\n\n- **Repository Structure section** describing the clean architecture with 4 main projects: LaundrySystem.Api (controllers, mappings, startup), LaundrySystem.BLL (services, integrations, DI), LaundrySystem.DAL (EF DbContext, repositories, migrations), LaundrySystem.Domain.Model (entities, models, responses); test projects using NUnit; Python code generation scripts; Media directory for assets\n\n- **Dependencies and Installation section** covering .NET 8.0 SDK requirement, NuGet package management with `dotnet restore`, SQL Server with Entity Framework Core, external services (Twilio SMS, Brevo/SendGrid email), key packages (EF Core, Identity, Mapster, JWT, Swagger), build with `dotnet build` and run with `dotnet run --project LaundrySystem.Api`\n\n- **Testing Instructions section** explaining NUnit framework usage, test project naming convention [ProjectName].Tests, run tests with `dotnet test`, focus on BLL and DAL layer testing, use coverlet.collector for coverage, follow NUnit [SetUp] and [Test] attributes, mock external dependencies, use separate test database for integration tests\n\n- **Pull Request Formatting section** left empty as no specific repository rules were found\n\nEach section must be properly wrapped in the required XML tags: ``, ``, ``, ``, ``" ]

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