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

[2.x] docs: Minor tweaks to the docs (#8480)

This commit is contained in:
eugene yokota 2026-01-11 15:08:20 -05:00 committed by GitHub
parent 985cf94bb7
commit 697e32e496
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 8 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
AGENTS.md
View File

@ -15,7 +15,7 @@ sbt compile
Pull reuqest guideline Pull reuqest guideline
---------------------- ----------------------
- Follow the PR guidance in <contributing-docs/01_pull_request.md>. - Follow the PR guidance in [contributing-docs/01_pull_request.md](contributing-docs/01_pull_request.md).
- In the commit message, include "Generated-by" tag for Gen-AI tools. - In the commit message, include "Generated-by" tag for Gen-AI tools.
Coding style Coding style
@ -34,9 +34,9 @@ Tests
Always add tests. For changes with small scopes prefer HedgeHog for Scala. 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. 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/04_unit_tests.md)
- <contributing-docs/05_scripted_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](contributing-docs/06_manual_tests.md)
Binary compatibility Binary compatibility
-------------------- --------------------

23
CONTRIBUTING.md
View File

@ -28,6 +28,10 @@ Ideas and proposals
If you have an enhancement idea, or a general discussion, please follow the [sbt 2.0 RFC process](https://eed3si9n.com/sbt-2.0-rfc-process) or start a [Discussion][Discussions]. If you have an enhancement idea, or a general discussion, please follow the [sbt 2.0 RFC process](https://eed3si9n.com/sbt-2.0-rfc-process) or start a [Discussion][Discussions].
Patching the core (send pull requests)
--------------------------------------
See a more detailed documentation [Sending pull request](contributing-docs/01_pull_request.md).
Reporting Issues Reporting Issues
---------------- ----------------
@ -98,26 +102,7 @@ On StackOverflow, it's:
Here's a simple sample case: [#327][327]. Here's a simple sample case: [#327][327].
Finally, thank you for taking the time to report a problem. Finally, thank you for taking the time to report a problem.
Pull Requests
-------------
See below for the branch to work against.
See [DEVELOPING](./DEVELOPING.md)
Profiling sbt Profiling sbt
------------- -------------
See [PROFILING](./PROFILING.md) See [PROFILING](./PROFILING.md)
Other notes
-----------
## Signing the CLA
Contributing to sbt requires you or your employer to sign the
[Scala Contributor License Agreement](https://contribute.akka.io/contribute/cla/scala).
To make it easier to respect our license agreements, we have added an sbt task
that takes care of adding the LICENSE headers to new files. Run `headerCreate`
and sbt will put a copyright notice into it.