Contribution Guide(s) need to be consolidated and updated #963
Labels
Comments
DFrenkel
added a commit
to DFrenkel/google-api-python-client
that referenced
this issue
Jul 8, 2020
DFrenkel
added a commit
to DFrenkel/google-api-python-client
that referenced
this issue
Jul 8, 2020
gcf-merge-on-green bot
pushed a commit
that referenced
this issue
Jul 9, 2020
* 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
gcf-merge-on-green bot
pushed a commit
that referenced
this issue
Jul 15, 2020
🤖 I have created a release \*beep\* \*boop\* --- ## [1.10.0](https://www.github.com/googleapis/google-api-python-client/compare/v1.9.3...v1.10.0) (2020-07-15) ### Features * allow to use 'six.moves.collections_abc.Mapping' in 'client_options.from_dict()' ([#943](https://www.github.com/googleapis/google-api-python-client/issues/943)) ([21af37b](https://www.github.com/googleapis/google-api-python-client/commit/21af37b11ea2d6a89b3df484e1b2fa1d12849510)) * Build universal wheels ([#948](https://www.github.com/googleapis/google-api-python-client/issues/948)) ([3e28a1e](https://www.github.com/googleapis/google-api-python-client/commit/3e28a1e0d47f829182cd92f37475ab91fa5e4afc)) * discovery supports retries ([#967](https://www.github.com/googleapis/google-api-python-client/issues/967)) ([f3348f9](https://www.github.com/googleapis/google-api-python-client/commit/f3348f98bf91a88a28bf61b12b95e391cc3be1ff)), closes [#848](https://www.github.com/googleapis/google-api-python-client/issues/848) ### Documentation * consolidating and updating the Contribution Guide ([#964](https://www.github.com/googleapis/google-api-python-client/issues/964)) ([63f97f3](https://www.github.com/googleapis/google-api-python-client/commit/63f97f37daee37a725eb05df3097b20d5d4eaaf0)), closes [#963](https://www.github.com/googleapis/google-api-python-client/issues/963) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please).
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
This repo contains a brief Contribution Guide in the
.githubdirectory.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
noxto 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.mdCONTRIBUTING.rstat the root of the repo that:README.mdto reference newCONTRIBUTING.rstperhaps reinforcing again basic requirements as bullet pointsThe text was updated successfully, but these errors were encountered: