mirror of https://github.com/sbt/sbt.git
Minor updates on development guide
This commit is contained in:
parent
16958769b0
commit
b2bf66364d
|
|
@ -98,34 +98,6 @@ Pull Requests
|
|||
|
||||
See below for the branch to work against.
|
||||
|
||||
### Adding notes
|
||||
|
||||
Most pull requests should include a "Notes" file which documents the change. This file should reside in the
|
||||
directory:
|
||||
|
||||
<sbt root>
|
||||
notes/
|
||||
<target release>/
|
||||
<your-change-name>.md
|
||||
|
||||
Notes files should have the following contents:
|
||||
|
||||
* Bullet item description under one of the following sections:
|
||||
- `### Bug fixes`
|
||||
- `### Improvements`
|
||||
- `### Fixes with compatibility implications`
|
||||
* Complete section describing new features.
|
||||
|
||||
### Clean history
|
||||
|
||||
Make sure you document each commit and squash them appropriately. You can use the following guides as a reference:
|
||||
|
||||
* Scala's documentation on [Git Hygiene](https://github.com/scala/scala/tree/v2.12.0-M3#git-hygiene)
|
||||
* Play's documentation on [Working with Git](https://www.playframework.com/documentation/2.4.4/WorkingWithGit#Squashing-commits)
|
||||
|
||||
Build from source
|
||||
-----------------
|
||||
|
||||
See [DEVELOPING](./DEVELOPING.md)
|
||||
|
||||
Profiling sbt
|
||||
|
|
@ -133,22 +105,8 @@ Profiling sbt
|
|||
|
||||
See [PROFILING](./PROFILING.md)
|
||||
|
||||
Other notes for maintainers
|
||||
---------------------------
|
||||
|
||||
### Publishing VS Code Extensions
|
||||
|
||||
Reference https://code.visualstudio.com/docs/extensions/publish-extension
|
||||
|
||||
```
|
||||
$ sbt
|
||||
> vscodePlugin/compile
|
||||
> exit
|
||||
cd vscode-sbt-scala/client
|
||||
# update version number in vscode-sbt-scala/client/package.json
|
||||
$ vsce package
|
||||
$ vsce publish
|
||||
```
|
||||
Other notes
|
||||
-----------
|
||||
|
||||
## Signing the CLA
|
||||
|
||||
|
|
|
|||
|
|
@ -7,15 +7,15 @@ Create a [fork](https://docs.github.com/en/github/getting-started-with-github/fo
|
|||
|
||||
### Branch to work against
|
||||
|
||||
sbt uses **two or three** branches for development:
|
||||
Generally the default branch set on Github is what we recommend as the base line for PRs.
|
||||
sbt uses two or three branches for development:
|
||||
Use the **default** branch set on Github for bug fixes.
|
||||
|
||||
- Next minor branch: `1.$MINOR.x`, where `$MINOR` is next minor version (e.g. `1.9.x` during 1.8.x series)
|
||||
- Next minor branch: `1.$MINOR.x`, where `$MINOR` is next minor version (e.g. `1.10.x` during 1.9.x series)
|
||||
- Development branch: `develop`
|
||||
- Stable branch: `1.$MINOR.x`, where `$MINOR` is current minor version (e.g. `1.8.x` during 1.8.x series)
|
||||
- Stable branch: `1.$MINOR.x`, where `$MINOR` is current minor version (e.g. `1.9.x` during 1.9.x series)
|
||||
|
||||
Currently `develop` branch represents the next major version of sbt, i.e. sbt 2.
|
||||
Next minor branch is where new features can be added as long as it is binary compatible with sbt 1.0.
|
||||
The `develop` branch represents sbt 2.x, the next major sbt series.
|
||||
Next minor branch is where new features should be added as long as it is binary compatible with sbt 1.x.
|
||||
The `stable` branch represents the current stable sbt release. Only bug fixes are back-ported to the stable branch.
|
||||
|
||||
### Instruction to build just sbt
|
||||
|
|
@ -167,6 +167,13 @@ command. To run a single test, such as the test in
|
|||
|
||||
### Random tidbits
|
||||
|
||||
### Clean history
|
||||
|
||||
Make sure you document each commit and squash them appropriately. You can use the following guides as a reference:
|
||||
|
||||
* Scala's documentation on [Git Hygiene](https://github.com/scala/scala/tree/v2.12.0-M3#git-hygiene)
|
||||
* Play's documentation on [Working with Git](https://www.playframework.com/documentation/2.4.4/WorkingWithGit#Squashing-commits)
|
||||
|
||||
#### Import statements
|
||||
|
||||
You'd need alternative DSL import since you can't rely on sbt package object.
|
||||
|
|
|
|||
Loading…
Reference in New Issue