Template updates (#581)

* Updated issue and PR templates
* Updated CONTRIBUTING information

Author: ricellis

.github/ISSUE_TEMPLATE.md

@@ -1,9 +1,28 @@
-Please include the following information in your ticket.
+Please [read these guidelines](http://ibm.biz/cdt-issue-guide) before opening an issue.
 
-- sync-android version(s) that are affected by this issue.
-- sync-android artifact you are using
+<!-- Issues will be CLOSED IMMEDIATELY if the following template is not completed. -->
+
+## Bug Description
+
+### 1. Steps to reproduce and the simplest code sample possible to demonstrate the issue
+<!--
+Outline the steps you take to make the problem happen.
+Provide the simplest code sample you can, in context, that reproduces the issue.
+-->
+
+### 2. What you expected to happen
+
+### 3. What actually happened
+
+## Environment details
+<!--
+- Version(s) that are affected by this issue.
+    > 2.0.2
+- Android or Java version (including vendor and platform)
+    > Android 5.1, API level 22, Linux/armv7l
+    > Java 1.8.0_151 OpenJDK macOS
+- sync-android artifact you are using:
     - [ ] cloudant-sync-datastore-android
     - [ ] cloudant-sync-datastore-android-encryption
     - [ ] cloudant-sync-datastore-javase
-- Android or Java version (including vendor and platform).
-- A small code sample that demonstrates the issue.
+-->

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,24 +1,102 @@
+<!--
 Thanks for your hard work, please ensure all items are complete before opening.
+-->
+## Checklist
 
-- [ ] Tick to sign-off your agreement to the [Developer Certificate of Origin (DCO) 1.1](https://github.com/cloudant/sync-android/blob/master/DCO1.1.txt)
-- [ ] You have added tests for any code changes
-- [ ] You have updated the [CHANGES.md](https://github.com/cloudant/sync-android/blob/master/CHANGES.md)
-- [ ] You have completed the PR template below:
+- [ ] Tick to sign-off your agreement to the [Developer Certificate of Origin (DCO) 1.1](../blob/master/DCO1.1.txt)
+- [ ] Added tests for code changes _or_ test/build only changes
+- [ ] Updated the change log file (`CHANGES.md`|`CHANGELOG.md`) _or_ test/build only changes
+- [ ] Completed the PR template below:
 
-## What
+## Description
+<!--
+Provide a short description; saving the detail for the `Approach` section
 
-What was changed e.g.
->Corrected NPE when trying to read settings from a migrated index.
+Also EITHER:
+Link to issue this PR is resolving, use the Fixes #nnn form so that the
+issue closes automatically when the PR merges e.g.:
 
-## How
+Fixes #23
 
-How the change was implemented and reasoning behind it, e.g.
->Added a null check before attempting to call getBytes for deserialization.
+OR
+
+For PRs without an associated issue and/or test/build issues
+
+### 1. Steps to reproduce and the simplest code sample possible to demonstrate the issue
+### 2. What you expected to happen
+### 3. What actually happened
+-->
+
+## Approach
+
+<!--
+Be brief: which component(s) of the code base does the fix focus on.
+
+A place to note whether the part of the code base that is being worked is
+particularly sensitive.
+-->
+
+## Schema & API Changes
+
+<!--
+EITHER:
+
+- "No change"
+
+OR
+
+For public API (as opposed to internal) changes
+
+- "Fixing bug in API, will change x in such-and-such way"
+-->
+
+## Security and Privacy
+
+<!--
+EITHER:
+
+- "No change"
+
+OR
+
+"Making changes in e.g. auth|https|encryption|io
+need to be careful about..."
+
+-->
 
 ## Testing
 
-How to test your changes work, not required for documentation changes.
+<!--
+EITHER:
+
+- Added new tests:
+    - test x
+    - test y
+    - test z
+
+OR
+
+- Modified existing tests because ...
+
+OR
+
+- N/A build or packaging only changes
+
+OR
+
+In exceptional circumstances there may be a good reason we can't add automated
+tests, for example if a specific device is required to reproduce a problem.
+
+- No new tests because...
+-->
+
+## Monitoring and Logging
+<!--
+EITHER:
+
+- "No change"
 
-## Issues
+OR
 
-Links to the github issue(s) (if present) that this pull request is resolving.
+- "Added new log line X..."
+-->

CONTRIBUTING.md

@@ -1,9 +1,19 @@
-# Developing this library
+# Contributing
 
-Cloudant Sync - Android is written in Java and uses
-[gradle](http://www.gradle.org) as its build tool.
+## Issues
+
+Please [read these guidelines](http://ibm.biz/cdt-issue-guide) before opening an issue.
+If you still need to open an issue then we ask that you complete the template as
+fully as possible.
+
+## Pull requests
 
-## Developer Certificate of Origin
+We welcome pull requests, but ask contributors to keep in mind the following:
+
+* Only PRs with the template completed will be accepted
+* We will not accept PRs for user specific functionality
+
+### Developer Certificate of Origin
 
 In order for us to accept pull-requests, the contributor must sign-off a
 [Developer Certificate of Origin (DCO)](DCO1.1.txt). This clarifies the
@@ -16,18 +26,12 @@ Please read the agreement and acknowledge it by ticking the appropriate box in t
 
 - [x] Tick to sign-off your agreement to the Developer Certificate of Origin (DCO) 1.1
 
-## Requirements
+## General information
 
-The main requirements are:
-
-* Java 1.6
-* Android SDK
-
-Optionally, and recommended:
-
-* CouchDB
+Cloudant Sync - Android is written in Java and uses
+[gradle](http://www.gradle.org) as its build tool.
 
-## Coding guidelines
+### Coding guidelines
 
 Adopting the [Google Java Style](https://google-styleguide.googlecode.com/svn/trunk/javaguide.html)
 with the following changes:
@@ -42,28 +46,39 @@ with the following changes:
 4.5.2
     Indent continuation of +4 characters fine, but I think
     IDEA defaults to 8, which is okay too.
-```
+    ```
+
+## Requirements
 
-## Installing requirements
+The main requirements are:
 
-### Java
+* Java 1.6
+* Android SDK
+
+Optionally, and recommended:
+
+* CouchDB
+
+### Installing requirements
+
+#### Java
 
 Follow the instructions for your platform.
 
 
-### CouchDB
+#### CouchDB
 
 Again, using brew:
 
 ```bash
 $ brew install couchdb
 ```
 
-### Android SDK
+#### Android SDK
 
 Follow the instructions provided on the android developer site.
 
-## Building the library
+## Building
 
 The project should build out of the box with:
 
@@ -83,6 +98,8 @@ maven repository:
 $ gradlew install
 ```
 
+## Testing
+
 ### Running integration tests
 
 These require a running couchdb: