You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
However, README references another Contribution Guide instead with similar, expanded, content.
Neither guides contain instructions for setting up this project to be able to do effective testing, such as:
Setup Instructions
Please follow these steps after 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 edible install
python3 -m pip install -e .
# Install nox
python3 -m pip install nox
From that point, you can just use nox to run linter and unit tests for all supported versions of Python and oauth2client defined in the noxfile.py
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 documentation.
I propose the following restructuring:
Remove .github/CONTRIBUTING.md
Create 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 above
Modify README.md to reference new CONTRIBUTING.rst perhaps reinforcing again basic requirements as bullet points
The text was updated successfully, but these errors were encountered:
* Removing `.github/CONTRIBUTING.md`
* Creating new `CONTRIBUTING.rst` at the root of the repo that:
* Links to the [Contribution Guide](http://googleapis.github.io/google-api-python-client/contributing.html) for basic housekeeping items such as CLA, Code of Conduct, Pull Requests, Style, Code Reviews.
* Provides setup instructions and introduces Nox
* Modifying `README.md` to reference new `CONTRIBUTING.rst`
Fixes: #963
This repo contains a brief Contribution Guide in the
.github
directory.However, README references another Contribution Guide instead with similar, expanded, content.
Neither guides contain instructions for setting up this project to be able to do effective testing, such as:
Setup Instructions
Please follow these steps after cloning the repository to make sure you can
modify code and run tests with confidence:
From that point, you can just use
nox
to run linter and unit tests for all supported versions of Python and oauth2client defined in the noxfile.pyNox 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 documentation.
I propose the following restructuring:
.github/CONTRIBUTING.md
CONTRIBUTING.rst
at the root of the repo that:README.md
to reference newCONTRIBUTING.rst
perhaps reinforcing again basic requirements as bullet pointsThe text was updated successfully, but these errors were encountered: