Convert to MarkDown
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.md similarity index 69% rename from CONTRIBUTING.rst rename to CONTRIBUTING.md index fa6cda0..a15c350 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.md
@@ -1,12 +1,13 @@ -Want to contribute? Great! First, read this page (including the small print at the end). +# How to Contribute -Before you contribute ---------------------- +Want to contribute? Great! First, read this page (including the small print at +the end). -Before we can use your code, you must sign the `Google Individual Contributor -License Agreement -<https://developers.google.com/open-source/cla/individual?csw=1>`_ (CLA), which -you can do online. The CLA is necessary mainly because you own the +## Before you contribute + +Before we can use your code, you must sign the [Google Individual Contributor +License Agreement](https://developers.google.com/open-source/cla/individual?csw=1) +(CLA), which you can do online. The CLA is necessary mainly because you own the copyright to your changes, even after your contribution becomes part of our codebase, so we need your permission to use and distribute your code. We also need to be sure of various other things—for instance that you'll tell us if you @@ -18,26 +19,23 @@ possibly guide you. Coordinating up front makes it much easier to avoid frustration later on. -Code reviews ------------- +## Code reviews All submissions, including submissions by project members, require review. We use Github pull requests for this purpose. -YAPF coding style ------------------ +## YAPF coding style -YAPF follows the `Google Python Style Guide -<https://google.github.io/styleguide/pyguide.html>`_ with two exceptions: +YAPF follows the [Google Python Style Guide](https://google.github.io/styleguide/pyguide.html) +with two exceptions: - 2 spaces for indentation rather than 4. -- CamelCase for function and method names rather than snake_case. +- CamelCase for function and method names rather than `snake_case`. The rationale for this is that YAPF was initially developed at Google where these two exceptions are still part of the internal Python style guide. -Small print ------------ +## Small print Contributions made by corporations are covered by a different agreement than the one above, the Software Grant and Corporate Contributor License Agreement.
diff --git a/MANIFEST.in b/MANIFEST.in index 5c70a55..9a8d602 100644 --- a/MANIFEST.in +++ b/MANIFEST.in
@@ -1,4 +1,4 @@ -include HACKING.rst LICENSE AUTHORS CHANGELOG CONTRIBUTING.rst CONTRIBUTORS +include HACKING.rst LICENSE AUTHORS CHANGELOG CONTRIBUTING.md CONTRIBUTORS include .coveragerc .editorconfig .flake8 plugins/README.rst include plugins/vim/autoload/yapf.vim plugins/vim/plugin/yapf.vim pylintrc include .style.yapf tox.ini .travis.yml .vimrc