Skip to content

NXENG-1002: add AGENTS.md agent instructions - #33

Merged
kevinleturc merged 1 commit into
mainfrom
task-NXENG-1002-agents-md
Oct 6, 2026
Merged

kevinleturc merged 1 commit into
mainfrom
task-NXENG-1002-agents-md

Conversation

@kevinleturc

@kevinleturc kevinleturc commented Oct 6, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Adds an AGENTS.md to guide AI coding agents working in this repository:

  • Repository purpose & module layout (per-module HttpClient → Service → object/ → mapper/ shape)
  • Build / format / test commands (Maven install, Spotless, e2e profile)
  • Design conventions distilled from past PR review history (typed contracts over Object, record/Optional/Duration usage, mapper-hierarchy + factory pattern, CICObject/CICArray typed getters, public-API collection immutability, no customer names, Git LFS for fixtures, etc.)
  • Commit/PR conventions

Related to NXENG-1002.

Opened as draft for review of tone/content before merging.

@kevinleturc
kevinleturc requested a review from troger October 6, 2026 09:08
Comment thread AGENTS.md Resolved
Comment thread AGENTS.md Resolved
Comment thread AGENTS.md Resolved
Comment thread AGENTS.md Resolved
@kevinleturc
kevinleturc force-pushed the task-NXENG-1002-agents-md branch 2 times, most recently from f78f05c to cc14b40 Compare October 6, 2026 10:33
@kevinleturc
kevinleturc requested a review from troger October 6, 2026 10:36
@kevinleturc
kevinleturc marked this pull request as ready for review October 6, 2026 10:37
@kevinleturc
kevinleturc force-pushed the task-NXENG-1002-agents-md branch from cc14b40 to 756e79b Compare October 6, 2026 10:48
Document module layout, build/format/test commands, and the design
conventions distilled from past PR review history (mapper hierarchy,
typed contracts over Object, record/Optional/Duration usage, public API
collection immutability, no customer names, Git LFS fixtures, etc.) to
guide AI coding agents working in this repository.
@kevinleturc
kevinleturc force-pushed the task-NXENG-1002-agents-md branch from 756e79b to 6340f59 Compare October 6, 2026 11:26
Comment thread AGENTS.md Resolved
@kevinleturc
kevinleturc merged commit 2b3f9b7 into main Oct 6, 2026
5 checks passed
@kevinleturc
kevinleturc deleted the task-NXENG-1002-agents-md branch October 6, 2026 15:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants