Merge pull request #131 from hydrosquall/feature/updating-contributing-and-release-notes

Updating contributing and release documentation

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,14 @@
+🎉 Hello there 🎉! Thanks for taking the time to contribute to `Tiingo-Python`!
+
+## Summary of Changes
+
+- What is the motivation / context for this change?
+- Is this a bugfix or a feature?
+- What does this change / fix? (Link to Github Issue page if applicable)
+
+## Checklist
+
+- [ ] Code follows the style guidelines of this project
+- [ ] Added tests for new functionality
+- [ ] Update `HISTORY.rst` with an entry summarizing your change
+- [ ] Tag a project maintainer

CONTRIBUTING.rst

@@ -105,6 +105,12 @@ Before you submit a pull request, check that it meets these guidelines:
    https://travis-ci.org/hydrosquall/tiingo-python/pull_requests
    and make sure that the tests pass for all supported Python versions.
 
+
+Release Procedure
+-----------------------
+
+See RELEASE.rst .
+
 Tips
 ----
 
@@ -125,4 +131,3 @@ In order for py.test to run, you will have had to create an environment variable
 However, now this api key will become embedded in the test fixture file that is created per the prior procedure.  In order to remove this api key from the new test fixtures, run the following from the top level directory::
 
     $ ./tools/api_key_tool.py
-

RELEASE.rst

@@ -0,0 +1,13 @@
+============
+Issuing New Releases
+============
+
+Tiingo follows semantic versioning (semver.org) practices. 
+
+The following shows how to make a release for version 0.8.0
+
+1. Make a branch called release/0.8.0
+2. Ensure HISTORY.rst (the Changelog) is up to date
+3. Update __version__.py to 0.8.0
+4. Open a merge request to master
+5. After the merge request is approved and merged, tag and push the merged commit with 0.8.0. Travis CI will be responsible for releasing the new code to PyPI.