luke/sbt

mirror of https://github.com/sbt/sbt.git synced 2026-09-03 08:34:34 +02:00

Files

T

it-education-md 7b5481ec3c [2.x] fix: Fix spelling and link in AGENTS docs (#8837 )

**Problem**
AGENTS.md contains a spelling typo in a section heading and a broken link for the tech stack document.

**Solution**
- Replaced "Pull reuqest guideline" with "Pull request guideline"
- Fixed tech stack link target to contributing-docs/07_tech_stack.md

2026-03-01 00:25:09 -05:00

1.6 KiB

Raw Blame History

AGENTS instructions

The main developer documentation is Contributor's guide.

Development environment

Compiling with sbt

sbt compile

Pull request guideline

Follow the PR guidance in 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

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.

Tech stack

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:

sbt mimaReportBinaryIssues

Copyright

NEVER reproduce copyrighted material.

1.6 KiB Raw Blame History