Skip to content

Commit

Permalink
Merge pull request #1080 from dhermes/add-contrib-note-about-abs-links
Browse files Browse the repository at this point in the history
Updating CONTRIBUTING.
  • Loading branch information
dhermes committed Aug 24, 2015
2 parents a1e0fed + 71b8658 commit 5609a84
Showing 1 changed file with 23 additions and 3 deletions.
26 changes: 23 additions & 3 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -258,6 +258,25 @@ can build the docs via::

$ tox -e docs

In addition, to build a preview of the `readthedocs`_ theme, you can
build via::

$ tox -e docs-rtd

.. _readthedocs: http://gcloud-python.readthedocs.org/

Note About ``README`` as it pertains to PyPI
--------------------------------------------

The `description on PyPI`_ for the project comes directly from the
``README``. Due to the reStructuredText (``rst``) parser used by
PyPI, relative links which will work on GitHub (e.g. ``CONTRIBUTING.rst``
instead of
``https://github.com/GoogleCloudPlatform/gcloud-python/blob/master/CONTRIBUTING.rst``)
may cause problems creating links or rendering the description.

.. _description on PyPI: https://pypi.python.org/pypi/gcloud

Travis Configuration and Build Optimizations
--------------------------------------------

Expand Down Expand Up @@ -290,9 +309,6 @@ We support:

- `Python 2.6`_
- `Python 2.7`_

We plan to support:

- `Python 3.3`_
- `Python 3.4`_

Expand All @@ -312,6 +328,9 @@ and lack of continuous integration `support`_.
.. _decreased usage: https://caremad.io/2013/10/a-look-at-pypi-downloads/
.. _support: http://blog.travis-ci.com/2013-11-18-upcoming-build-environment-updates/

We may `drop 2.6`_ as a supported version as well since Python 2.6 is no
longer supported by the core development team.

We also explicitly decided to support Python 3 beginning with version
3.3. Reasons for this include:

Expand All @@ -322,6 +341,7 @@ We also explicitly decided to support Python 3 beginning with version

.. _projects: http://flask.pocoo.org/docs/0.10/python3/
.. _Unicode literal support: https://www.python.org/dev/peps/pep-0414/
.. _drop 2.6: https://github.com/GoogleCloudPlatform/gcloud-python/issues/995

Contributor License Agreements
------------------------------
Expand Down

0 comments on commit 5609a84

Please sign in to comment.