diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..0613635 --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,56 @@ + + +# AGENTS.md + +This file provides guidance for AI coding agents that work in this repository. + +## Build and verification + +- Format the code before you commit: + - `mvn spotless:apply` +- Verify that the pull request is ready: + - `mvn spotless:check` + - `mvn checkstyle:check` + - `mvn apache-rat:check` + - `mvn verify` (runs the unit tests and the RAT license check) +- Make sure all of the commands above pass before you open or update a pull + request. + +## Test-first programming + +Write a failing test before you implement a fix or a feature: + +1. Write a test that reproduces the bug, or that specifies the new behavior. +2. Run the test and confirm that it fails. The failure must match the bug that + you are fixing. +3. Implement the change. +4. Run the test again and confirm that it passes. +5. Run `mvn verify` to confirm that nothing else is broken. + +## Documentation style + +Use ASD-STE100 Simplified Technical English for documentation. This includes +the README, the site documentation, javadoc, and code comments: + +- Write short sentences. +- Write one idea per sentence. +- Use only the approved vocabulary and the approved meanings for words. +- Use the active voice. +- Write precisely and without ambiguity.