From 27dc6205664a7cf38ee82a50db2f6436fe1c65c2 Mon Sep 17 00:00:00 2001
From: 2-4601 <git@othermemory.org>
Date: Tue, 29 Mar 2016 23:37:47 +0300
Subject: [PATCH] Update issue and pull request templates

Issue template
 - more explanations and tips
 - clarify how to fill checkboxes
 - actual and expected results
 - remove link to the community forum

PR template
 - clarify how to fill checkboxes
 - more about tests
 - add a link to an explanation for BitHub rewards
 - explain that failing Travis CI build checks are normal

Closes #735

// FREEBIE
---
 .github/ISSUE_TEMPLATE.md        | 30 ++++++++++++++++--------------
 .github/PULL_REQUEST_TEMPLATE.md | 28 ++++++++++++++++++----------
 2 files changed, 34 insertions(+), 24 deletions(-)

diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
index 1c5e65b7a..881de2750 100644
--- a/.github/ISSUE_TEMPLATE.md
+++ b/.github/ISSUE_TEMPLATE.md
@@ -1,30 +1,31 @@
-<!--
-Please note that this is an issue tracker
+<!-- This is a bug report template. By following the instructions below and filling out the sections with your information, you will help the developers to get all the necessary data to fix your issue.
+You can also preview your report before submitting it. You may remove sections that aren't relevant to your particular case.
 
-For support go to the Support Center:
+Before we begin, please note that this tracker is only for issues, not questions or comments.
+
+If you are looking for support, please see our support center instead:
 http://support.whispersystems.org/
 or email support@whispersystems.org
 
-For discussion go to the community forum:
-https://whispersystems.discoursehosting.net
+Let's begin with a checklist: please replace the empty checkbox [ ] below with a checked one [x] if you have searched for existing issues -->
 
-Delete any sections that aren't relevant.
--->
-
-<!-- mark with x between the [ ] -->
 - [ ] I have searched open and closed issues for duplicates
 
+----------------------------------------
 
 ### Bug description
-
+Describe here the issue that you are experiencing.
 
 ### Steps to reproduce
-- add your steps here
-- as a list
-- using hyphens
+- using hyphens as bullet points
+- list the steps
+- that reproduce the bug
+
+**Actual result:** Describe here what happens after you run the steps above (i.e. the buggy behaviour)
+**Expected result:** Describe here what should happen after you run the steps above (i.e. what would be the correct behaviour)
 
 ### Screenshots
-<!-- you can drag and drop images here -->
+<!-- you can drag and drop images below -->
 
 
 ### Platform info
@@ -34,3 +35,4 @@ Delete any sections that aren't relevant.
 **Signal version:** Z.Y.Y
 
 ### Link to debug log
+<!-- immediately after the bug has happened submit a debug log via the ⋮ menu above the conversation list -->
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index 0e05c8311..db860c394 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,20 +1,28 @@
-<!-- You can remove this section if you have contributed before -->
+<!-- You can remove this first section if you have contributed before -->
 ### First time contributor checklist
-<!-- mark with x between the brackets -->
-- [ ] I have read the [Contributor Guidelines](https://github.com/WhisperSystems/Signal-Desktop/blob/master/CONTRIBUTING.md)
+<!-- replace the empty checkboxes [ ] below with checked ones [x] accordingly -->
+- [ ] I have read the [README](https://github.com/WhisperSystems/Signal-Desktop/blob/master/README.md) and [Contributor Guidelines](https://github.com/WhisperSystems/Signal-Desktop/blob/master/CONTRIBUTING.md)
 - [ ] I have signed the [Contributor Licence Agreement](https://whispersystems.org/cla/)
 
 ### Contributor checklist
-<!-- mark with x between the brackets -->
+<!-- replace the empty checkboxes [ ] below with checked ones [x] accordingly -->
+- [ ] My contribution is fully baked and ready to be merged as is
 - [ ] My changes are rebased on the latest master branch
-- [ ] My contribution is fully baked and is ready to be merged as is
-- [ ] I have run the tests on these platforms:
+- [ ] My commits are in nice logical chunks
+- [ ] I have followed the [best practices](http://chris.beams.io/posts/git-commit/) in my commit messages
+- [ ] I have made the choice whether I want the [BitHub reward](https://github.com/WhisperSystems/Signal-Android/wiki/BitHub-Rewards) or not by omitting or adding the word `FREEBIE` in my Git commit messages
+- [ ] I have tested my contribution on these platforms:
  * GNU Hurd 1.0, Chrom{e,ium} X.Y.Z
  * Amiga OS 3.1, Chrom{e,ium} Z.Y
-- [ ] My commits are in nice logical chunks
-- [ ] I followed the [best practices](http://chris.beams.io/posts/git-commit/) when writing my commit messages
-- [ ] I have made the choice whether I want the Bithub reward or not by omitting or adding the word `FREEBIE` in my commit message
+- [ ] My changes pass all the [local tests](https://github.com/WhisperSystems/Signal-Desktop/blob/master/CONTRIBUTING.md#tests) 100%
+- [ ] I have considered whether my changes need additional [tests](https://github.com/WhisperSystems/Signal-Desktop/blob/master/CONTRIBUTING.md#tests), and in the case they do, I have written them
 
-----------
+----------------------------------------
 
 ### Description
+<!--
+Describe briefly what your pull request proposes to fix. Especially if you have more than one commit, it is helpful to give a summary of what your contribution as a whole is trying to solve.
+Also, please describe shortly how you tested that your fix actually works.
+
+Please note, that after you have submitted your PR, the Travis CI build check will fail. This is a known issue (#708) and you don't have to worry about it. (■_■¬)
+-->