github: Fill in more contributing doc. Add issue/PR templates.

[ci skip]

cherry picks 3d6309d a317ea0

Author: chfoo

CONTRIBUTING.md

@@ -3,33 +3,101 @@ Contributing
 
 Thank you for your interest in contributing!
 
+
 Issues
 ------
 
-When reporting a bug, please include:
+Hopefully you are arriving from
+[the documentation](https://wpull.readthedocs.io/). If not, please take
+a moment to read it. Updated documentation is provided on "latest"
+version.
+
+When reporting a bug or asking a question, please search to see if your
+bug report exists or your question has been already answered.
+
+When opening an issue, include lots of details about your problem and
+information that we can use to reproduce the problem. There are many
+resources that describe how to file a good bug report such as
+<https://developer.mozilla.org/en-US/docs/Mozilla/QA/Bug_writing_guidelines>.
 
-1. What you want, what you expect, what happened.
-2. The command or website causes the problem
-3. Operating system
-4. Python version
-5. Wpull version
-6. A copy and paste of what Wpull prints out
+Concisely, we need to know:
+
+* What you want
+* What you expect
+* What happened
+* Commands to reproduce the issue
+* Program versions
+* Your computer details
+* Debugging output
+
+When you file an issue, a template should appear for you to fill out.
 
 
 Pull requests
 -------------
 
-Before making a pull request, please review the following:
+If you are planning to fix a bug or add a feature, please take some
+time to review this section.
+
+
+### Code convention
+
+Please follow the [PEP8](https://www.python.org/dev/peps/pep-0008/)
+conventions whenever possible. 
+
+If the current code does not follow it, please do not make
+a pull request that formats all the code with a program automatically.
+Instead, incrementally make the corrections that are affected in your
+bug fixes or features. This will help make Git's blame feature easier
+use.
+
+
+### Commits and commit messages
+
+Please don't PR a single huge commit or hundreds of commits. Do your
+best to group changes logically.
+
+Give your commit messages meaningful descriptions. Make the first line
+a short title describing the changes and then add an optional paragraph
+describing why you made those changes.
+
+
+### Branch model
+
+This project is still small but we intend to follow 
+[nvie's git branching model]
+(http://nvie.com/posts/a-successful-git-branching-model/) to structure
+the Git repository in the future. This means:
+
+* The stable code is located on the `master` branch which is the default.
+* The current work of focus is located on the `develop` branch.
+* There is currently no release branches.
+* Changes flow into the `develop` branch, then the `master` branch.
+
+Because of the branching model, there are two options of branching:
+
+* From a stable point, that is the `master` branch
+* From an active point, that is a the `develop` branch
+
+If you are making a small bug fix and are new to this project, we
+suggest branching off the `master` branch so we can integrate your
+changes properly. Otherwise, branch off the `develop` branch.
+
+If you are adding a feature, please branch from the `develop` branch. 
+If you branch from `master`, your changes may not merge anymore on the
+next release. If needed, file an issue to discuss the roadmap of the
+feature to avoid any rejection and disappointment.
+
+One branch per bug/feature. Don't stack PR on top of other PR branches!
+
 
-1. Your branch is branched from the `master` branch or a release tag.
-2. You want to merge into the `develop` branch.
-3. Commits are logical units of changes.
-4. Commit messages are usefully descriptive.
-5. Unit tests are modified or appended as needed.
-6. Inline documentation is accurate.
-7. A rationale for the pull request is provided.
+### Making the PR
 
-We follow [nvie's git branching
-model](http://nvie.com/posts/a-successful-git-branching-model/) and
-PEP8 code style.
+When you file a pull request, a template will appear reminding you
+of this document. It will also remind you to:
 
+* Update or add unit tests if needed.
+* Update or add documentation/comments if needed.
+* Describe *what* you changed and *why* you changed them.
+* Set GitHub merge options to merge into `develop` if you branch
+  from `develop`.

ISSUE_TEMPLATE.md

@@ -0,0 +1,21 @@
+Please fill this or delete as needed. You can use toolbar and preview feature located above this textbox.
+
+*What I wanted:* Describe what you want to achieve here
+ 
+*What I expect:* Describe how you think the program will work
+
+*What happened:* Describe what actually happened instead
+
+*The command or website causes the problem:* Copy the options provided to Wpull here
+
+*Operating system:* Write your OS name here such as Windows 10/Ubuntu Linux 14.04 32-bit/OS X 10.10
+
+*Python version:* What does `python --version` say?
+
+*Wpull version:* What does `wpull --version` say?
+
+*Log/Output:* Put a pastebin link here that does not expire or
+
+```
+Copy a snippet of the log or what Wpull outputs here
+```

PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,17 @@
+Please fill this or delete as needed:
+
+This pull request fixes #N (where N is the issue number).
+
+I remembered to:
+
+* [ ] Update or add unit tests if needed
+* [ ] Update or add documentation/comments if needed
+* [ ] Made sure stray files or whitespace didn't get committed
+* [ ] If significant changes, branch from `develop` and set to merge into `develop`
+* [ ] Read the guidelines for contributing
+
+Changes:
+
+* Fill in change here because reason here
+* Fill in change here because reason here
+* Fill in change here because reason here