Skip to content

AGENTS.md

Latest commit

 

History

History
119 lines (87 loc) · 6.09 KB

AGENTS.md

File metadata and controls

119 lines (87 loc) · 6.09 KB

Main Entry Point

Always follow these rule files very carefully, as they have been crafted to ensure consistency and high-quality code.

Git Commit Policy

Wait for the user to request git operations (commit, amend, revert). Each request grants permission for that operation only.

  • ✅ Always wait for user to request a commit
  • ❌ Be proactive about commits—user will always initiate
  • ❌ After completing work, ask if user wants to commit
  • ❌ Commit after finishing a task without being asked
  • ❌ Run revert or amend to fix a mistake—let user decide
  • ❌ Treat one commit request as permission for later commits

Development Approach

When working on tasks, follow any specific workflow instructions provided for your role. If no specific workflow is provided:

  1. Understand the problem and requirements clearly.

  2. Consult the relevant rule files before implementation.

  3. Develop a clear implementation plan.

  4. Follow established patterns and conventions.

  5. Use MCP tools for building, testing, and formatting.

    Always use MCP tools instead of running dotnet build, dotnet test, dotnet format, or equivalent npm and npx playwright commands directly.

    Execution Order (mandatory):

    1. Run build first: execute_command(command='build', backend=true, frontend=true)
    2. Run remaining tools with noBuild=true

    Slow Operations:

    • Aspire restart
    • Backend format
    • Backend lint
    • End-to-end tests

    Fast Operations:

    • Frontend format, lint
    • Backend test

    Parallelization rule:

    • If running only fast operations → run sequentially
    • If running any slow operation → run EVERYTHING in parallel Task agents

    Example: running all tools after build (do NOT use run_in_background):

    Task(subagent_type: "general-purpose", prompt: "Restart Aspire: mcp__developer-cli__run()", run_in_background: false)
Task(subagent_type: "general-purpose", prompt: "Test backend: mcp__developer-cli__execute_command(command='test', backend=true, noBuild=true)", run_in_background: false)
Task(subagent_type: "general-purpose", prompt: "Format backend: mcp__developer-cli__execute_command(command='format', backend=true, noBuild=true)", run_in_background: false)
Task(subagent_type: "general-purpose", prompt: "Lint backend: mcp__developer-cli__execute_command(command='lint', backend=true, noBuild=true)", run_in_background: false)
Task(subagent_type: "general-purpose", prompt: "Run e2e: mcp__developer-cli__end_to_end(browser='chromium', waitForAspire=true)", run_in_background: false)

    Format, lint, and test run while Aspire starts. End-to-end tests use waitForAspire=true to wait until Aspire is ready.

    About Aspire: The run MCP tool starts the Aspire AppHost at https://localhost:9000. Restart it when the backend has changed, when frontend hot reload stops working, or when it is not running.

    MCP Server Setup: See .mcp.json for MCP server configuration. For Claude Code, run claude config set enableAllProjectMcpServers true once to enable project-scoped MCP servers.

Critical: If you do NOT see the mentioned developer-cli MCP tool, tell the user. Do NOT just ignore that you cannot find them, and fall back to other tools.

CLI Alias Configuration

Whenever you see [CLI_ALIAS], replace it with the configured value.

CLI_ALIAS="pp"

Product Management Tool

Whenever you see [PRODUCT_MANAGEMENT_TOOL], replace it with the configured value.

PRODUCT_MANAGEMENT_TOOL="Linear"

Rules for implementing changes

Always consult the relevant rule files before each code change.

Please note that I often correct or even revert code you generated. If you notice that, take special care not to revert my changes.

Commit messages should be in imperative form, start with a capital letter, avoid ending punctuation, be a single line, and concisely describe changes and motivation.

Be very careful with comments, and add them only very sparingly. Never add comments about changes made (these belong in pull requests).

Edit Discipline

When using the Edit tool:

  • The new_string must be a minimal transformation of old_string
  • Never remove, modify, or add comments unless that is the explicit task
  • Never reformat code, fix whitespace, or "clean up" adjacent lines
  • If you need to include surrounding context for uniqueness, copy it exactly

Project Structure

This is a mono repository with multiple self-contained systems (SCS), each being a small monolith. All SCSs follow the same structure.

  • .github: GitHub workflows and other GitHub artifacts.
  • application: Contains application code:
    • account: An SCS for tenant and user management:
      • WebApp: A React, TypeScript SPA.
      • Api: .NET 10 minimal API.
      • Core: .NET 10 Vertical Sliced Architecture.
      • Workers: A .NET Console job.
      • Tests: xUnit tests for backend.
    • back-office: An empty SCS that will be used to create tools for Support and System Admins:
      • WebApp: A React, TypeScript SPA.
      • Api: .NET 10 minimal API.
      • Core: .NET 10 Vertical Sliced Architecture.
      • Workers: A .NET Console job.
      • Tests: xUnit tests for backend.
    • AppHost: Aspire project for orchestrating SCSs and Docker containers. Never run directly—typically running in watch mode.
    • AppGateway: Main entry point using YARP as reverse proxy for all SCSs.
    • shared-kernel: Reusable .NET backend shared by all SCSs.
    • shared-webapp: Reusable frontend shared by all SCSs.
  • cloud-infrastructure: Bash and Azure Bicep scripts (IaC).
  • developer-cli: A .NET CLI tool for automating common developer tasks.