AGENTS instructions
===================

The main developer documentation is [Contributor's guide](contributing-docs/README.md).

- [Development environment](contributing-docs/02_development_environment.md)

Compiling with sbt
------------------

```bash
sbt --client --color=false --supershell=false --batch compile
```

Pull request guideline
----------------------

- Follow the PR guidance in [CONTRIBUTING.md](./CONTRIBUTING.md).
- [ ] Before working on a pull request, please confirm that **you can reproduce the reported problem** using GitHub Actions or your computer.
- [ ] After making the code change, please confirm that **your change compiles, and has fixed the problem**.
- [ ] In the commit message, include "Generated-by" tag for Gen-AI tools.

Coding style
------------

```bash
sbt --client --color=false --supershell=false --batch scalafmtAll
```

- Follow [Coding style and best practices](contributing-docs/03_coding_style.md)
- For newly written code, avoid braces in Scala 3.x, that is use SIP-44 Fewer Braces syntax.
- Prefer scala.util.Using over try-finally.
- Avoid inline comments!

Tests
-----

Always add tests. For changes with small scopes prefer HedgeHog for Scala.
For changes that require coordination with file changes and tasks, use scripted test.

- [contributing-docs/04_unit_tests.md](contributing-docs/04_unit_tests.md)
- [contributing-docs/05_scripted_tests.md](contributing-docs/05_scripted_tests.md)
- [contributing-docs/06_manual_tests.md](contributing-docs/06_manual_tests.md)

For example, here's how to run "actions/compile" scripted test:

```bash
sbt --color=false --supershell=false --client --batch scripted actions/compile
```

Tech stack
----------

- [contributing-docs/07_tech_stack.md](contributing-docs/07_tech_stack.md)

Binary compatibility
--------------------

sbt MUST maintain backward binary compatibility across minor releases.
This means removing public method signature MUST be avoided.

Use mima to check:

```bash
sbt --client --color=false --supershell=false --batch mimaReportBinaryIssues
```

Copyright
---------

- NEVER reproduce copyrighted material.