From d19b59cc788e3dbb31b81356418be4f53a79afaa Mon Sep 17 00:00:00 2001 From: Dale Wijnand Date: Wed, 17 Feb 2016 23:09:36 +0000 Subject: [PATCH 1/3] Add issue & pr templates --- ISSUE_TEMPLATE.md | 18 ++++++++++++++++++ PULL_REQUEST_TEMPLATE.md | 3 +++ 2 files changed, 21 insertions(+) create mode 100644 ISSUE_TEMPLATE.md create mode 100644 PULL_REQUEST_TEMPLATE.md diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md new file mode 100644 index 000000000..59f102ab2 --- /dev/null +++ b/ISSUE_TEMPLATE.md @@ -0,0 +1,18 @@ +(For more details see the guidelines for contributing linked above) + +## steps + + + +## problem + + + +## expectation + + + +## notes + + + diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..2d6aaa76e --- /dev/null +++ b/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,3 @@ +(Strongly consider adding notes for this change) + + From 855d2b65ded99b86cbb8a8485a4995ff82798329 Mon Sep 17 00:00:00 2001 From: Dale Wijnand Date: Thu, 18 Feb 2016 16:44:20 +0000 Subject: [PATCH 2/3] Trim the templates --- ISSUE_TEMPLATE.md | 2 -- PULL_REQUEST_TEMPLATE.md | 2 -- 2 files changed, 4 deletions(-) diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md index 59f102ab2..3953ce47d 100644 --- a/ISSUE_TEMPLATE.md +++ b/ISSUE_TEMPLATE.md @@ -14,5 +14,3 @@ ## notes - - diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md index 2d6aaa76e..f6c26c19d 100644 --- a/PULL_REQUEST_TEMPLATE.md +++ b/PULL_REQUEST_TEMPLATE.md @@ -1,3 +1 @@ (Strongly consider adding notes for this change) - - From f20e12edf2c5c0f5aa28985f82748ef9cdd4327a Mon Sep 17 00:00:00 2001 From: Dale Wijnand Date: Thu, 18 Feb 2016 16:44:41 +0000 Subject: [PATCH 3/3] Add "Clean history" to contributing with links --- CONTRIBUTING.md | 12 +++++++++++- ISSUE_TEMPLATE.md | 2 +- PULL_REQUEST_TEMPLATE.md | 2 +- 3 files changed, 13 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 314e1079c..72fd633e7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 ------------- diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md index 3953ce47d..748cd9fd1 100644 --- a/ISSUE_TEMPLATE.md +++ b/ISSUE_TEMPLATE.md @@ -1,4 +1,4 @@ -(For more details see the guidelines for contributing linked above) +(See the guidelines for contributing, linked above) ## steps diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md index f6c26c19d..0392fc0ee 100644 --- a/PULL_REQUEST_TEMPLATE.md +++ b/PULL_REQUEST_TEMPLATE.md @@ -1 +1 @@ -(Strongly consider adding notes for this change) +(See the guidelines for contributing, linked above)