Skip to content
Browse files
docs: consolidating and updating the Contribution Guide (#964)
* Removing `.github/`
* Creating new `CONTRIBUTING.rst` at the root of the repo that:
    * Links to the [Contribution Guide]( for basic housekeeping items such as CLA, Code of Conduct, Pull Requests, Style, Code Reviews.
    * Provides setup instructions and introduces Nox
* Modifying `` to reference new `CONTRIBUTING.rst` 

Fixes: #963
  • Loading branch information
DFrenkel committed Jul 9, 2020
1 parent 3e28a1e commit 63f97f37daee37a725eb05df3097b20d5d4eaaf0
Showing with 64 additions and 29 deletions.
  1. +0 鈭28 .github/
  2. +61 鈭0 CONTRIBUTING.rst
  3. +3 鈭1

This file was deleted.

@@ -0,0 +1,61 @@
How to Contribute

We'd love to accept your patches and contributions to this project.
There are a few guidelines described in our
`Contribution Guide <>`__
that you need to follow.

To summarize here: when contributing, please:

* Sign Contributor License Agreement
* Before making changes, file an issue
* Fork this repository and use github pull requests for all submissions
* Follow
`Contributor Code of Conduct
and `Community Guidelines <>`__
* Follow `Google Python Style Guide <>`__
and `this commit authoring style <>`__
* Don't forget to write tests and update documentation!

Setup Notes

Please follow these steps after forking and cloning the repository
to make sure you can modify code and run tests with confidence::

# From the root dir of the cloned repository:
# Create Virtual Environment called env (you may choose your own name)
python3 -m venv env

# Activate virtual environment
source env/bin/activate

# Install this library as editable install
# (see
python3 -m pip install -e .

# Install nox
python3 -m pip install nox

We use `nox <>`__ to instrument our tests.
To test your changes, run unit tests with ``nox``::

# Run tests for all supported versions of Python and oauth2client:
# Run tests for Python 3.7:
nox -s unit-3.7
# Run lint
nox -s lint

.. note::

The unit tests and system tests are described in the
```` file in this directory. Nox will automatically
handle constriction of new virtual environments and installation
of the required test dependencies.

For more information about Nox, including command-line usage, consult
`nox documentation <>`__.
@@ -66,4 +66,6 @@ For development you will also need the following libraries:

## Contributing

Please see the [contributing page]( for more information. In particular, we love pull requests - but please make sure to sign the contributor license agreement.
Please see our [Contribution Guide](CONTRIBUTING.rst).
In particular, we love pull requests - but please make sure to sign
the contributor license agreement.

0 comments on commit 63f97f3

Please sign in to comment.