From fea94a9feccdc234fead2d74c9bcdc72e598186d Mon Sep 17 00:00:00 2001
From: John Gee <john@ruru.gen.nz>
Date: Tue, 13 Aug 2019 21:28:50 +1200
Subject: [PATCH] Move CONTRIBUTING and add PULL_REQUEST_TEMPLATE (#1017)

* Move CONTRIBUTING to top level for increased visibility

* Add PR template to guide contributors

* Oops, fix name
---
 .github/PULL_REQUEST_TEMPLATE.md           | 48 ++++++++++++++++++++++
 .github/CONTRIBUTING.md => CONTRIBUTING.md |  3 ++
 2 files changed, 51 insertions(+)
 create mode 100644 .github/PULL_REQUEST_TEMPLATE.md
 rename .github/CONTRIBUTING.md => CONTRIBUTING.md (97%)

diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 000000000..1323b94ff
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,48 @@
+# Pull Request
+
+<!--
+The text in these markdown comments is instructions that will not appear in the displayed pull request,
+and can be deleted.
+
+Please submit pull requests against the develop branch.
+
+Follow the existing code style. Check the tests succeed, including lint.
+  npm run test
+  npm run lint
+
+Don't update the CHANGELOG or command version number. That gets done by maintainers when preparing the release.
+
+Commander currently has zero production dependencies. That isn't a hard requirement, but is a simple story. Requests which 
+add a dependency are much less likely to be accepted, and we are likely to ask if there alternative approaches to avoid the dependency.
+-->
+
+## Problem
+
+<!--
+What problem are you solving?
+What Issues does this relate to?
+Show the broken output if appropriate.
+-->
+
+## Solution
+
+<!--
+How did you solve the problem? 
+Show the fixed output if appropriate.
+
+There are a lot of forms of documentation which could need updating for a change in functionality. It
+is ok if you want to show us the code to discuss before doing the extra work, and
+you should say so in your comments so we focus on the concept first before talking about all the other pieces:
+
+- TypeScript typings
+- JSDoc documentation in code
+- tests
+- README
+- examples/
+-->
+
+## ChangeLog
+
+<!--
+Optional. Suggest a line for adding to the CHANGELOG to summarise your change.
+-->
diff --git a/.github/CONTRIBUTING.md b/CONTRIBUTING.md
similarity index 97%
rename from .github/CONTRIBUTING.md
rename to CONTRIBUTING.md
index 984bd0e06..f11d40397 100644
--- a/.github/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -16,6 +16,9 @@ Pull Requests will be considered. Please submit pull requests against the develo
 
 Follow the existing code style. Check the tests succeed, including lint.
 
+- `npm run test`
+- `npm run lint`
+
 Don't update the CHANGELOG or command version number. That gets done by maintainers when preparing the release.
 
 Useful things to include in your request description are: