luke
/
sbt
mirror of https://github.com/sbt/sbt.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
sbt/AGENTS.md

1.2 KiB
Raw Blame History

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

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>

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.