Skip to content

[Repo Assist] Add AGENTS.md with build, test, and formatting instructions #235

Description

@github-actions

🤖 This PR was created by Repo Assist, an automated AI assistant.

Closes #232

What

Adds an AGENTS.md file at the repository root as requested in #232.

Why

AGENTS.md is the standard location for build/test/format instructions used by AI coding agents (and is useful for human contributors too). Having this file allows agents to automatically discover:

  • How to restore tools and dependencies (dotnet tool restore + dotnet paket restore)
  • How to build the solution (./build.sh / build.cmd or specific FAKE targets)
  • How to run the .NET and Fable test suites
  • How to check and apply Fantomas formatting (which CI enforces)
  • The overall CI pipeline and what must pass before merge
  • Project structure overview
  • Contribution guidelines

Contents summary

The file covers:

Section Details
Prerequisites .NET 8 SDK, Node 24+, Yarn
Restore dotnet tool restore + dotnet paket restore
Build ./build.sh / build.cmd, common FAKE targets table
Tests FAKE targets + direct dotnet test commands + Fable/Yarn instructions
Formatting Fantomas check and auto-format commands; note that CI enforces CheckFormat
CI pipeline Summary of what the GitHub Actions workflow runs
Project structure Directory tree
Contribution guidelines PR focus, test requirements, dependency policy

Test Status

No source code was changed — this is documentation only. The CI pipeline will validate that no formatting or build issues were introduced.

Generated by Repo Assist for issue #232 ·

To install this agentic workflow, run

gh aw add githubnext/agentics/workflows/repo-assist.md@30f2254f2a7a944da1224df45d181a3f8faefd0d

Warning

🛡️ Protected Files

This was originally intended as a pull request, but the patch modifies protected files: AGENTS.md.

These files may affect project dependencies, CI/CD pipelines, or agent behaviour. Please review the changes carefully before creating the pull request.

Click here to create the pull request once you have reviewed the changes

To route changes like this to a review issue instead of blocking, configure protected-files: fallback-to-issue in your workflow configuration.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions