From 1e059345b23b84a29234e36e0f243b33272e1274 Mon Sep 17 00:00:00 2001
From: Brian Heim <brianlheim@gmail.com>
Date: Thu, 6 Jul 2017 09:02:53 -0400
Subject: [PATCH 01/10] Add GitHub issue & PR templates

Add issue and PR templates according to
https://github.com/blog/2111-issue-and-pull-request-templates

This helps contributors to share the right details at the start of a
thread, cutting down on miscommunication and under-informed reporting
---
 .github/ISSUE_TEMPLATE.md        | 37 ++++++++++++++++++++++++++++++++
 .github/PULL_REQUEST_TEMPLATE.md | 27 +++++++++++++++++++++++
 2 files changed, 64 insertions(+)
 create mode 100644 .github/ISSUE_TEMPLATE.md
 create mode 100644 .github/PULL_REQUEST_TEMPLATE.md

diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
new file mode 100644
index 00000000000..ef820944df4
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE.md
@@ -0,0 +1,37 @@
+<!--- Provide a general summary of the issue in the Title above -->
+
+## Expected Behavior
+<!--- If you're describing a bug, tell us what should happen -->
+<!--- If you're suggesting a change/improvement, tell us how it should work -->
+
+## Current Behavior
+<!--- If describing a bug, tell us what happens instead of the expected behavior -->
+<!--- If suggesting a change/improvement, explain the difference from current behavior -->
+
+## Possible Solution
+<!--- Not obligatory, but suggest a fix/reason for the bug, -->
+<!--- or ideas how to implement the addition or change -->
+
+## Steps to reproduce (for bugs)
+
+```supercollider
+// Please paste SuperCollider code here.
+// Try to make your example as minimal as possible.
+```
+
+## Error message (for bugs)
+
+```
+// Please paste any error messages here.
+// Link to a Gist (https://gist.github.com) if the message is long.
+```
+
+## Context
+<!--- How has this issue affected you? What are you trying to accomplish? -->
+<!--- Providing context helps us come up with a solution that is most useful in the real world -->
+
+## Your Environment
+<!--- Include as many relevant details about the environment you experienced the bug in -->
+* Version used:
+* Operating System and version:
+
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 00000000000..99a805d7e2e
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,27 @@
+<!--- Provide a general summary of your changes in the title above -->
+
+## Purpose
+
+<!--- Please describe the purpose of the pull request. -->
+
+## Motivation and Context
+
+<!--- Why is this change required? What problem does it solve? -->
+<!--- If it fixes an open issue, please link to the issue here. -->
+
+## Types of changes
+
+<!--- What types of changes does your pull request introduce? Put an `x` in all the boxes that apply: -->
+- [ ] Documentation (non-code change which corrects or adds documentation for existing features)
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to change)
+
+## Checklist
+
+- [ ] All tests are passing
+- [ ] New tests were created to address changes in PR (and tests are passing)
+- [ ] Updated README and/or documentation, if necessary
+
+<!--- Thanks for contributing! -->
+

From 8c401ce7a0a88b5fffe93c53b0bcdcb79aed33a3 Mon Sep 17 00:00:00 2001
From: Brian Heim <brianlheim@gmail.com>
Date: Thu, 6 Jul 2017 23:11:35 -0400
Subject: [PATCH 02/10] Issue template: move environment section to the top

---
 .github/ISSUE_TEMPLATE.md | 11 +++++------
 1 file changed, 5 insertions(+), 6 deletions(-)

diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
index ef820944df4..85afca19f54 100644
--- a/.github/ISSUE_TEMPLATE.md
+++ b/.github/ISSUE_TEMPLATE.md
@@ -1,5 +1,10 @@
 <!--- Provide a general summary of the issue in the Title above -->
 
+## Environment
+* SuperCollider version:
+* Operating system and version:
+<!--- Include any other relevant details about your environment (Qt version, audio driver, etc.) -->
+
 ## Expected Behavior
 <!--- If you're describing a bug, tell us what should happen -->
 <!--- If you're suggesting a change/improvement, tell us how it should work -->
@@ -29,9 +34,3 @@
 ## Context
 <!--- How has this issue affected you? What are you trying to accomplish? -->
 <!--- Providing context helps us come up with a solution that is most useful in the real world -->
-
-## Your Environment
-<!--- Include as many relevant details about the environment you experienced the bug in -->
-* Version used:
-* Operating System and version:
-

From 930a8789edab2103db40ffd53bf39c1dd64bd824 Mon Sep 17 00:00:00 2001
From: Brian Heim <brianlheim@gmail.com>
Date: Thu, 6 Jul 2017 23:11:56 -0400
Subject: [PATCH 03/10] Issue template: remove context section

---
 .github/ISSUE_TEMPLATE.md | 4 ----
 1 file changed, 4 deletions(-)

diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
index 85afca19f54..c3a1d34c3ec 100644
--- a/.github/ISSUE_TEMPLATE.md
+++ b/.github/ISSUE_TEMPLATE.md
@@ -30,7 +30,3 @@
 // Please paste any error messages here.
 // Link to a Gist (https://gist.github.com) if the message is long.
 ```
-
-## Context
-<!--- How has this issue affected you? What are you trying to accomplish? -->
-<!--- Providing context helps us come up with a solution that is most useful in the real world -->

From d6f4558146a19bed27003f1307d73cde487584de Mon Sep 17 00:00:00 2001
From: Brian Heim <brianlheim@gmail.com>
Date: Thu, 6 Jul 2017 23:12:53 -0400
Subject: [PATCH 04/10] Issue template: move Possible Solution section to end,
 clearly mark as optional

---
 .github/ISSUE_TEMPLATE.md | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
index c3a1d34c3ec..f0a7cf29ee6 100644
--- a/.github/ISSUE_TEMPLATE.md
+++ b/.github/ISSUE_TEMPLATE.md
@@ -13,10 +13,6 @@
 <!--- If describing a bug, tell us what happens instead of the expected behavior -->
 <!--- If suggesting a change/improvement, explain the difference from current behavior -->
 
-## Possible Solution
-<!--- Not obligatory, but suggest a fix/reason for the bug, -->
-<!--- or ideas how to implement the addition or change -->
-
 ## Steps to reproduce (for bugs)
 
 ```supercollider
@@ -30,3 +26,7 @@
 // Please paste any error messages here.
 // Link to a Gist (https://gist.github.com) if the message is long.
 ```
+
+## Possible Solution (optional)
+<!--- Not obligatory, but suggest a fix/reason for the bug, -->
+<!--- or ideas how to implement the addition or change -->

From 8531bcceccc4a4a9e57e417aeefca297abfb5014 Mon Sep 17 00:00:00 2001
From: Brian Heim <brianlheim@gmail.com>
Date: Thu, 6 Jul 2017 23:13:34 -0400
Subject: [PATCH 05/10] Issue template: add thank-you to end

---
 .github/ISSUE_TEMPLATE.md | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
index f0a7cf29ee6..dc2fe35eaf8 100644
--- a/.github/ISSUE_TEMPLATE.md
+++ b/.github/ISSUE_TEMPLATE.md
@@ -30,3 +30,5 @@
 ## Possible Solution (optional)
 <!--- Not obligatory, but suggest a fix/reason for the bug, -->
 <!--- or ideas how to implement the addition or change -->
+
+<!--- Thanks for contributing! -->

From a964faf029ccda753508cd7796f19762db425fdc Mon Sep 17 00:00:00 2001
From: Brian Heim <brianlheim@gmail.com>
Date: Thu, 6 Jul 2017 23:15:45 -0400
Subject: [PATCH 06/10] Pull request template: merge purpose &
 motivation/context sections

---
 .github/PULL_REQUEST_TEMPLATE.md | 7 ++-----
 1 file changed, 2 insertions(+), 5 deletions(-)

diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index 99a805d7e2e..8c1de2d5d74 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,11 +1,8 @@
 <!--- Provide a general summary of your changes in the title above -->
 
-## Purpose
-
-<!--- Please describe the purpose of the pull request. -->
-
-## Motivation and Context
+## Purpose and Motivation
 
+<!--- Please describe the purpose and motivation of the pull request. -->
 <!--- Why is this change required? What problem does it solve? -->
 <!--- If it fixes an open issue, please link to the issue here. -->
 

From 29ec5ba1900ab8a4cb23625189b6f560d157b030 Mon Sep 17 00:00:00 2001
From: Brian Heim <brianlheim@gmail.com>
Date: Thu, 6 Jul 2017 23:21:31 -0400
Subject: [PATCH 07/10] Pull request template: add checkbox and comment for
 listing work to do

---
 .github/PULL_REQUEST_TEMPLATE.md | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index 8c1de2d5d74..688bc934b8d 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -19,6 +19,10 @@
 - [ ] All tests are passing
 - [ ] New tests were created to address changes in PR (and tests are passing)
 - [ ] Updated README and/or documentation, if necessary
+- [ ] This PR is ready for review
+
+<!--- If any work remains to be done, please give a brief description here. -->
+<!--- Consider providing a todo-list so we can easily track completion progress. -->
 
 <!--- Thanks for contributing! -->
 

From 0eeb61aaa63828dab1e90512bb367e1444979023 Mon Sep 17 00:00:00 2001
From: Brian Heim <brianlheim@gmail.com>
Date: Thu, 6 Jul 2017 23:23:05 -0400
Subject: [PATCH 08/10] Pull request template: update wording of checklist

---
 .github/PULL_REQUEST_TEMPLATE.md | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index 688bc934b8d..8e3164af577 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -17,8 +17,8 @@
 ## Checklist
 
 - [ ] All tests are passing
-- [ ] New tests were created to address changes in PR (and tests are passing)
-- [ ] Updated README and/or documentation, if necessary
+- [ ] If necessary, new tests were created to address changes in PR (and tests are passing)
+- [ ] Updated documentation, if necessary
 - [ ] This PR is ready for review
 
 <!--- If any work remains to be done, please give a brief description here. -->

From ca74afaff4a6a8405c17d849df20ededc9b81ae4 Mon Sep 17 00:00:00 2001
From: Brian Heim <brianlheim@gmail.com>
Date: Fri, 7 Jul 2017 10:24:25 -0400
Subject: [PATCH 09/10] Issue template: encourage users to post full stack
 trace

---
 .github/ISSUE_TEMPLATE.md | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
index dc2fe35eaf8..d7b0a9295c2 100644
--- a/.github/ISSUE_TEMPLATE.md
+++ b/.github/ISSUE_TEMPLATE.md
@@ -23,7 +23,8 @@
 ## Error message (for bugs)
 
 ```
-// Please paste any error messages here.
+// Please paste any error messages here in their entirety.
+// If this is a SuperCollider error message, include the full stack trace.
 // Link to a Gist (https://gist.github.com) if the message is long.
 ```
 

From 2a172c9b3ae637ee6cd9d221754580333f750199 Mon Sep 17 00:00:00 2001
From: Brian Heim <brianlheim@gmail.com>
Date: Sun, 9 Jul 2017 14:27:28 -0400
Subject: [PATCH 10/10] Issue template: remove possible solution section

---
 .github/ISSUE_TEMPLATE.md | 4 ----
 1 file changed, 4 deletions(-)

diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
index d7b0a9295c2..827b5903784 100644
--- a/.github/ISSUE_TEMPLATE.md
+++ b/.github/ISSUE_TEMPLATE.md
@@ -28,8 +28,4 @@
 // Link to a Gist (https://gist.github.com) if the message is long.
 ```
 
-## Possible Solution (optional)
-<!--- Not obligatory, but suggest a fix/reason for the bug, -->
-<!--- or ideas how to implement the addition or change -->
-
 <!--- Thanks for contributing! -->