Skip to content

chore: add AGENTS.md #201

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
fbeaudoincoveo merged 2 commits into from
Jul 22, 2026
Merged

chore: add AGENTS.md #201

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
11de295
docs: add AGENTS guide for build test lint
Copilot Jul 22, 2026
7e7ccee
docs: reduce duplication in AGENTS prerequisites
Copilot Jul 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# AGENTS.md

## Prerequisites

Install the following before running any project task:

- Java 11 or higher
- Apache Maven 3.6+
- (If installing from GitHub Packages) a GitHub personal access token with `read:packages` scope configured in `~/.m2/settings.xml`

## Build

Required installs: see [Prerequisites](#prerequisites).

Build command:

```bash
mvn -B package --file pom.xml
```

## Test

Required installs: see [Prerequisites](#prerequisites).

Test command:

```bash
mvn test
```

## Lint

Required installs: see [Prerequisites](#prerequisites).

Lint/format check command:

```bash
mvn spotless:check
```
Loading