From 3f73d55c3f7592b6055eeca81df24f5cd259e7f3 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?J=C3=BCrg=20Lehni?= <juerg@scratchdisk.com>
Date: Sat, 3 Feb 2018 22:39:07 +0100
Subject: [PATCH] Improve README and GitHub templates

---
 .github/ISSUE_TEMPLATE.md        | 23 ++++++++++++-----------
 .github/PULL_REQUEST_TEMPLATE.md | 15 +++++++++------
 README.md                        | 17 ++++++++++-------
 3 files changed, 31 insertions(+), 24 deletions(-)

diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
index 9e70902f..dbd9148a 100644
--- a/.github/ISSUE_TEMPLATE.md
+++ b/.github/ISSUE_TEMPLATE.md
@@ -1,20 +1,21 @@
 <!--
-Questions:
-  https://groups.google.com/group/paperjs
-  https://gitter.im/paperjs/paper.js
+This issues database is used to keep track of bugs and new features.
+For questions and support, please visit the Gitter channel instead:
+  https://gitter.im/Vincit/objection.js
 -->
 
 # Description/Steps to reproduce
 
 <!--
-If feature: A description of the feature
-If bug: Steps to reproduce
+If a feature: A description of the feature.
+If a bug: The steps to reproduce the issue.
 -->
 
 # Link to reproduction test-case
 
 <!--
-Link to a test-case for reproduction
+Please link to a test-case for reproduction, ideally as a repository with a
+`packages.json` that installs all required dependencies to reduce confusion.
 
 Note: Failure to provide a test-case for reproduction purposes will result in
 the issue being closed.
@@ -23,16 +24,16 @@ the issue being closed.
 # Expected result
 
 <!--
-Also include actual results if bug
+Also include actual results when reporting a bug.
 -->
 
 # Additional information
 
 <!--
-Please include the versions of Operating System and Browser that the issue is
-encountered on.
+Please include the type and versions of Operating System, Node, as well as
+the underlying database that the issue is encountered on.
 
 Examples:
-  macOS 10.12.6, Chrome 60.0.3112.113
-  Windows 10 Pro 10586.962, Edge 25.10586.672.0
+  macOS 10.12.6, Node 8.9.0, PostgreSQL 10.0
+  Windows 10 Pro 10586.962, Node 8.8.1, SQLite 3
 -->
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index 65cb209d..71930db5 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -4,21 +4,24 @@
 #### Related issues
 
 <!--
-Please use the following link syntaxes:
+Please list related issues and discussion by using the following syntax:
 
-- relates to #49 (to reference issues in the current repository)
+- Relates to #49
+  (to reference issues in the Objection.js repository)
+- Relates to https://github.com/tgriesser/knex/issues/100
+  (to reference issues in a related repository)
 -->
 
-- relates to <link_to_referenced_issue>
+- Relates to <link_to_referenced_issue>
 
 ### Checklist
 
 <!--
 - Please mark your choice with an "x" (i.e. [x], see
-https://github.com/blog/1375-task-lists-in-gfm-issues-pulls-comments)
+  https://github.com/blog/1375-task-lists-in-gfm-issues-pulls-comments)
 - PR's without test coverage will be closed.
 -->
 
 - [ ] New tests added or existing tests modified to cover all changes
-- [ ] Code conforms with the [style
-  guide](https://github.com/paperjs/paper.js/blob/develop/RULES.md)
+- [ ] Code conforms with the ESLint and Prettier rules (`yarn eslint` passes
+      and `yarn prettier` has been applied)
diff --git a/README.md b/README.md
index af1e7037..5d9a40d5 100644
--- a/README.md
+++ b/README.md
@@ -8,8 +8,10 @@ from [http://paperjs.org/download/](http://paperjs.org/download/)
 - Mainline source code: <https://github.com/paperjs/paper.js>
 - Twitter: [@paperjs](http://twitter.com/paperjs)
 - Latest releases: <http://paperjs.org/download/>
-- Pre-built development versions: [`prebuilt/module`](https://github.com/paperjs/paper.js/tree/prebuilt/module)
-and [`prebuilt/dist`](https://github.com/paperjs/paper.js/tree/prebuilt/dist) branches.
+- Pre-built development versions:
+  [`prebuilt/module`](https://github.com/paperjs/paper.js/tree/prebuilt/module)
+  and [`prebuilt/dist`](https://github.com/paperjs/paper.js/tree/prebuilt/dist)
+  branches.
 
 ## Installing Paper.js
 
@@ -280,10 +282,10 @@ The main Paper.js source tree is hosted on GitHub, thus you should create a fork
 of the repository in which you perform development. See
 <http://help.github.com/forking/>.
 
-We prefer that you send a [pull request on GitHub](http://help.github.com/pull-requests/) 
-which will then be merged into the
-official main line repository. You need to sign the Paper.js CLA to be able to
-contribute (see below).
+We prefer that you send a
+[pull request on GitHub](http://help.github.com/pull-requests/) 
+which will then be merged into the official main line repository.
+You need to sign the Paper.js CLA to be able to contribute (see below).
 
 Also, in your first contribution, add yourself to the end of `AUTHORS.md` (which
 of course is optional).
@@ -358,4 +360,5 @@ For a list of authors and contributors, please see
 ## License
 
 Distributed under the MIT license. See 
-[LICENSE](https://github.com/paperjs/paper.js/blob/master/LICENSE.txt) for details.
+[LICENSE](https://github.com/paperjs/paper.js/blob/master/LICENSE.txt)
+fo details.