From f20e12edf2c5c0f5aa28985f82748ef9cdd4327a Mon Sep 17 00:00:00 2001 From: Dale Wijnand Date: Thu, 18 Feb 2016 16:44:41 +0000 Subject: [PATCH] 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)