Merge pull request #336 from sourceryinstitute/doc-cleanup

Tweak PR, ISSUE templates and CONTRIBUTING.md

Author: zbeekman

.github/ISSUE_TEMPLATE.md

@@ -4,6 +4,12 @@
 <!-- Fill out all portions of this template that apply. Please delete -->
 <!-- any unnecessary sections. -->
 
+| Avg response time              |
+| ------------------------------ |
+| ![Issue Stats][issue stat img] |
+
+Please replace `[ ]` with `[X]` to indicate you have taken the requested action
+
  - [ ] I have surrounded any code, or log output in codeblock fences
        (` ``` `) if it occupies more than one line, or in single
        backticks if it is short `short code`
@@ -40,8 +46,6 @@ willing to help out please also read the [Helping Out] section of
 The title of the issue should start with `Defect:` followed by a
 succinct title.
 
-Please replace `[ ]` with `[X]` to indicate you have taken the requested action
-
  - [ ] I have searched the [issues page] and [mailing list] and did
        not find any issue matching the one I would like to report
  - [ ] I have included a succinct description of the problem,
@@ -75,7 +79,8 @@ Please replace `[ ]` with `[X]` to indicate you have taken the requested action
        changing the extension to `.txt` and uploaded it to this issue
  - [ ] I have indicated if previous versions of OpenCoarrays are or
        were installed on the machine in question
-<!-- please select one from the top level-->
+
+**Please select one from the following top level items** (please be sure to fill out all sub-items)**:**
  - [ ] Build/install was attempted with [install.sh]
     - [ ] I have attached the `install-opencoarrays.log` file
           after re-running the script with the debug flags `-d` and
@@ -100,18 +105,19 @@ us, the faster, and more easily we can help you
 
 <!-- delete this section if it does not apply -->
 
-<!-- pick one of the first two -->
+**Please choose one of the first two items**
  - [ ] I am experiencing a compile time error (all gfortran ICEs
        should be reported to the [GFortran bug tracker]... You can post
        the ICE here too for tracking purposes, with a link to the
        GFortran problem report)
  - [ ] I am experiencing a runtime issue
+
+**:sparkles: Optional, but you will receive infinite karma for including this: :sparkles:**
  - [ ] I have included a minimally complete verifiable example (MCVE)
        that exhibits the problem and suitable for adding to regression
-       tests (optional, but you receive infinite karma
-       for including this)
+       tests
 
-Description with as many details as possible to reproduce the problem.
+Don't forget a description with as many details as possible to reproduce the problem.
 
 
 [links]:#
@@ -129,3 +135,4 @@ Description with as many details as possible to reproduce the problem.
 [issues page]: https://github.com/sourceryinstitute/opencoarrays/issues
 [mailing list]: https://groups.google.com/forum/#!forum/opencoarrays
 [install.sh]: https://github.com/sourceryinstitute/opencoarrays/blob/master/install.sh
+[issue stat img]:https://img.shields.io/issuestats/i/github/sourceryinstitute/OpenCoarrays.svg?style=flat-square

.github/PULL_REQUEST_TEMPLATE.md

@@ -4,6 +4,10 @@
 <!-- Fill out all portions of this template that apply. Please delete -->
 <!-- any unnecessary sections. -->
 
+| Avg response time                 | coverage on master         |
+| --------------------------------- | ---------------------------|
+| ![Issue Stats][PR response img]   | ![Codecov branch][coverage]|
+
 This pull request (PR) is a:
  - [ ] Bug fix
  - [ ] Feature addition
@@ -40,6 +44,7 @@ I certify that:
  - [ ] I have signed  [Contributor License Agreement (CLA)] by
        clicking the "details" link to the right of the `licence/cla`
        check and following the directions on the CLA assistant webpage
+ - [ ] I have ensured that the test coverage hasn't gone down and added new [unit tests] to cover an new code added to the library
 
 ## Summary of changes ##
 
@@ -63,3 +68,6 @@ Why did you make these changes?
 [pullapprove comment]: https://pullapprove.com/sourceryinstitute/opencoarrays/settings/
 [Github code review]: https://help.github.com/articles/about-pull-request-reviews/
 [Github keywords]: https://help.github.com/articles/closing-issues-via-commit-messages/
+[unit tests]: https://github.com/sourceryinstitute/OpenCoarrays/tree/master/src/tests/unit
+[PR response img]: https://img.shields.io/issuestats/p/github/sourceryinstitute/OpenCoarrays.svg?style=flat-square
+[coverage]: https://img.shields.io/codecov/c/github/sourceryinstitute/OpenCoarrays/master.svg?style=flat-square

CONTRIBUTING.md

@@ -3,6 +3,10 @@
 Contributing to OpenCoarrays
 ============================
 
+[![](https://img.shields.io/github/issues-closed-raw/sourceryinstitute/OpenCoarrays.svg?style=flat-square)](https://github.com/sourceryinstitute/OpenCoarrays)
+[![Issue Stats](https://img.shields.io/issuestats/i/github/sourceryinstitute/OpenCoarrays.svg?style=flat-square)](https://github.com/sourceryinstitute/OpenCoarrays/issues)
+[![](https://img.shields.io/github/issues-pr-closed-raw/sourceryinstitute/OpenCoarrays.svg?style=flat-square)](https://github.com/sourceryinstitute/OpenCoarrays/pulls)
+[![Issue Stats](https://img.shields.io/issuestats/p/github/sourceryinstitute/OpenCoarrays.svg?style=flat-square)](https://github.com/sourceryinstitute/opencoarrays/pulls)
 [![Download as PDF][pdf img]](http://md2pdf.herokuapp.com/sourceryinstitute/opencoarrays/blob/master/CONTRIBUTING.pdf)
 
 Download this file as a PDF document
@@ -91,6 +95,21 @@ The `master` branch should remain in pristine, stable condition all of the time.
 
 This is the development branch, akin to GCC's `trunk`. Both of `devel` and `master` branches are protected, but `devel` will eventually be merged into `master` when the next major release happens, but until then it is a stable, forward looking branch where experimental features and major changes or enhancements may be applied and tested. Just as with `master` all changes are applied atomically as pull requests.
 
+## Through put ##
+
+[![Waffle.io](https://img.shields.io/waffle/label/sourceryinstitute/opencoarrays/blocked.svg?style=flat-square)](https://github.com/sourceryinstitute/OpenCoarrays/labels/blocked)
+[![Waffle.io](https://img.shields.io/waffle/label/sourceryinstitute/opencoarrays/ready.svg?style=flat-square)](https://github.com/sourceryinstitute/OpenCoarrays/labels/ready)
+[![Waffle.io](https://img.shields.io/waffle/label/sourceryinstitute/opencoarrays/in-progress.svg?style=flat-square)](https://github.com/sourceryinstitute/OpenCoarrays/labels/in-progress)
+[![Waffle.io](https://img.shields.io/waffle/label/sourceryinstitute/opencoarrays/needs%20review.svg?style=flat-square)](https://github.com/sourceryinstitute/OpenCoarrays/labels/needs-review)
+
+[![Throughput Graph](https://graphs.waffle.io/sourceryinstitute/opencoarrays/throughput.svg)](https://waffle.io/sourceryinstitute/opencoarrays/metrics/throughput)
+
+## Coverage ##
+
+[![Codecov branch](https://img.shields.io/codecov/c/github/sourceryinstitute/OpenCoarrays/master.svg?style=flat-square)](https://codecov.io/gh/sourceryinstitute/OpenCoarrays)
+
+[![coverage history](https://codecov.io/gh/sourceryinstitute/opencoarrays/branch/master/graphs/commits.svg)](https://codecov.io/gh/sourceryinstitute/OpenCoarrays)
+
 ---
 
 [![GitHub forks](https://img.shields.io/github/forks/sourceryinstitute/opencoarrays.svg?style=social&label=Fork)](https://github.com/sourceryinstitute/opencoarrays/fork)
@@ -100,6 +119,7 @@ This is the development branch, akin to GCC's `trunk`. Both of `devel` and `mast
 
 
 [Links]: #
+[issue template]: https://github.com/sourceryinstitute/OpenCoarrays/blob/master/.github/ISSUE_TEMPLATE.md
 [video]: https://youtu.be/EwWZbyjDs9c?list=PLg7s6cbtAD17uAwaZwiykDci_q3te3CTY
 [a number of resources]: http://scottchacon.com/2011/08/31/github-flow.html
 [Github flow]: https://guides.github.com/introduction/flow/