mirror of https://github.com/sbt/sbt.git
Add "Clean history" to contributing with links
This commit is contained in:
parent
855d2b65de
commit
f20e12edf2
|
|
@ -80,10 +80,13 @@ Finally, thank you for taking the time to report a problem.
|
|||
Pull Requests
|
||||
-------------
|
||||
|
||||
### Branch to work against
|
||||
|
||||
Whether implementing a new feature, fixing a bug, or modifying documentation, please work against the latest development branch (currently, 0.13).
|
||||
Binary compatible changes will be backported to a previous series (currently, 0.12.x) at the time of the next stable release.
|
||||
See below for instructions on building sbt from source.
|
||||
|
||||
### Adding notes
|
||||
|
||||
All pull requests are required to include a "Notes" file which documents the change. This file should reside in the
|
||||
directory:
|
||||
|
||||
|
|
@ -100,6 +103,13 @@ Notes files should have the following contents:
|
|||
- `### 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)
|
||||
|
||||
Documentation
|
||||
-------------
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
(For more details see the guidelines for contributing linked above)
|
||||
(See the guidelines for contributing, linked above)
|
||||
|
||||
## steps
|
||||
|
||||
|
|
|
|||
|
|
@ -1 +1 @@
|
|||
(Strongly consider adding notes for this change)
|
||||
(See the guidelines for contributing, linked above)
|
||||
|
|
|
|||
Loading…
Reference in New Issue