mirror of https://github.com/sbt/sbt.git
1.4 KiB
1.4 KiB
AGENTS instructions
The main developer documentation is Contributor's guide.
Compiling with sbt
sbt compile
Pull reuqest guideline
- Follow the PR guidance in contributing-docs/01_pull_request.md.
- In the commit message, include "Generated-by" tag for Gen-AI tools.
Coding style
sbt scalafmtAll
- Follow Coding style and best practices
- 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/05_scripted_tests.md
- contributing-docs/06_manual_tests.md
Tech stack
Binary compatibility
sbt MUST maintain backward binary compatibility across minor releases. This means removing public method signature MUST be avoided.
Use mima to check:
sbt mimaReportBinaryIssues
Copyright
- NEVER reproduce copyrighted material.