Cleanup (#638)

Refactored README and CONTRIBUTING docs
Updated changelog

Author: reyang

CHANGELOG.md

@@ -1,6 +1,8 @@
 # Changelog
 
 ## Unreleased
+- Refactored PeriodicTask
+  ([#632](https://github.com/census-instrumentation/opencensus-python/pull/632))
 
 ## 0.5.0
 Released 2019-04-24

CONTRIBUTING.md

@@ -1,23 +1,61 @@
-# How to Contribute
+# How to contribute
 
-We'd love to accept your patches and contributions to this project. There are
-just a few small guidelines you need to follow.
+We definitely welcome patches and contributions to OpenCensus! Here are
+some guidelines and information about how to do so.
 
-## Contributor License Agreement
+## Before getting started
 
-Contributions to this project must be accompanied by a Contributor License
-Agreement. You (or your employer) retain the copyright to your contribution,
-this simply gives us permission to use and redistribute your contributions as
-part of the project. Head over to <https://cla.developers.google.com/> to see
-your current agreements on file or to sign a new one.
-
-You generally only need to submit a CLA once, so if you've already submitted one
-(even if it was for a different project), you probably don't need to do it
-again.
+In order to protect both you and ourselves, you will need to sign the
+[Contributor License Agreement](https://cla.developers.google.com/clas).
 
 ## Code reviews
 
 All submissions, including submissions by project members, require review. We
 use GitHub pull requests for this purpose. Consult
 [GitHub Help](https://help.github.com/articles/about-pull-requests/) for more
 information on using pull requests.
+
+## Instructions
+
+Prerequisites:
+
+* You need to have Python installed.
+* You need to fork the project in GitHub.
+
+Clone the upstream repo:
+
+```sh
+$ git clone https://github.com/census-instrumentation/opencensus-python.git
+```
+
+Add your fork as an origin:
+
+```sh
+$ git remote add fork https://github.com/YOUR_GITHUB_USERNAME/opencensus-python.git
+```
+
+Run tests:
+
+```sh
+$ pip install nox-automation  # Only first time.
+$ nox
+```
+
+Checkout a new branch, make modifications and push the branch to your fork:
+
+```sh
+$ git checkout -b feature
+# edit files
+$ git commit
+$ git push fork feature
+```
+
+Open a pull request against the main opencensus-python repo.
+
+### Additional instructions for extension developers
+
+If you want to contribute new [extensions](README.rst#extensions), you need some extra steps:
+
+* Prepare the extension code, put it under the [contrib](./contrib/) folder.
+* Update [nox.py](./nox.py) to include your new extension for testing purpose.
+* Update [README](./README.rst#extensions) to include your extension.

README.rst

@@ -227,57 +227,22 @@ Stats Exporter
 .. _threading: https://github.com/census-instrumentation/opencensus-python/tree/master/contrib/opencensus-ext-threading
 .. _Zipkin: https://github.com/census-instrumentation/opencensus-python/tree/master/contrib/opencensus-ext-zipkin
 
-------------------
- Additional Info
-------------------
-
-Contributing
+------------
+ Versioning
 ------------
 
-Contributions to this library are always welcome and highly encouraged.
-
-See `CONTRIBUTING <CONTRIBUTING.md>`__ for more information on how to
-get started.
-
-
-Development
------------
-
-Tests
-~~~~~
-
-::
-
-    cd trace
-    tox -e py34
-    source .tox/py34/bin/activate
-
-    # Install nox with pip
-    pip install nox-automation
-
-    # See what's available in the nox suite
-    nox -l
-
-    # Run a single nox command
-    nox -s "unit(py='2.7')"
-
-    # Run all the nox commands
-    nox
-
-    # Integration test
-    # We don't have script for integration test yet, but can test as below.
-    python setup.py bdist_wheel
-    cd dist
-    pip install opencensus-0.0.1-py2.py3-none-any.whl
-
-    # Then just run the tracers normally as you want to test.
-
-License
--------
+This library follows `Semantic Versioning`_.
 
-Apache 2.0 - See `LICENSE <LICENSE>`__ for more information.
+**GA**: Libraries defined at a GA quality level are stable, and will not introduce
+backwards-incompatible changes in any minor or patch releases. We will address issues and requests
+with the highest priority. If we were to make a backwards-incompatible changes on an API, we will
+first mark the existing API as deprecated and keep it for 18 months before removing it.
 
-Disclaimer
-----------
+**Beta**: Libraries defined at a Beta quality level are expected to be mostly stable and we're
+working towards their release candidate. We will address issues and requests with a higher priority.
+There may be backwards incompatible changes in a minor version release, though not in a patch
+release. If an element is part of an API that is only meant to be used by exporters or other
+opencensus libraries, then there is no deprecation period. Otherwise, we will deprecate it for 18
+months before removing it, if possible.
 
-This is not an official Google product.
+.. _Semantic Versioning: https://semver.org/

contrib/opencensus-ext-azure/CHANGELOG.md

@@ -1,6 +1,8 @@
 # Changelog
 
 ## Unreleased
+- Add persistent storage support
+  ([#632](https://github.com/census-instrumentation/opencensus-python/pull/632))
 
 ## 0.1.0
 Released 2019-04-24