mirror of https://github.com/sbt/sbt.git
Merge pull request #2463 from dwijnand/add-issue-and-pr-templates
Add issue & pr templates
This commit is contained in:
commit
3c839ff3d3
|
|
@ -80,10 +80,13 @@ Finally, thank you for taking the time to report a problem.
|
||||||
Pull Requests
|
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).
|
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.
|
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
|
All pull requests are required to include a "Notes" file which documents the change. This file should reside in the
|
||||||
directory:
|
directory:
|
||||||
|
|
||||||
|
|
@ -100,6 +103,13 @@ Notes files should have the following contents:
|
||||||
- `### Fixes with compatibility implications`
|
- `### Fixes with compatibility implications`
|
||||||
* Complete section describing new features.
|
* 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
|
Documentation
|
||||||
-------------
|
-------------
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,16 @@
|
||||||
|
(See the guidelines for contributing, linked above)
|
||||||
|
|
||||||
|
## steps
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## problem
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## expectation
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## notes
|
||||||
|
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
(See the guidelines for contributing, linked above)
|
||||||
Loading…
Reference in New Issue