Skip to content
Permalink
Browse files
docs: update python contributing guide (#514)
This PR was generated using Autosynth. 🌈

Synth log will be available here:
https://source.cloud.google.com/results/invocations/9d4e6069-5c18-4f79-97fb-99ebae377691/targets

- [ ] To automatically regenerate this PR, check this box.

Source-Link: googleapis/synthtool@4679e7e
PiperOrigin-RevId: 344443035
Source-Link: googleapis/googleapis@df4fd38
  • Loading branch information
yoshi-automation committed Feb 17, 2021
1 parent 4ffb4e0 commit 01e851d00fc17a780375580776753d78f6d74174
Showing with 22 additions and 7 deletions.
  1. +18 −4 CONTRIBUTING.rst
  2. +4 −3 synth.metadata
@@ -70,9 +70,14 @@ We use `nox <https://nox.readthedocs.io/en/latest/>`__ to instrument our tests.
- To test your changes, run unit tests with ``nox``::

$ nox -s unit-2.7
$ nox -s unit-3.7
$ nox -s unit-3.8
$ ...

- Args to pytest can be passed through the nox command separated by a `--`. For
example, to run a single test::

$ nox -s unit-3.8 -- -k <name of test>

.. note::

The unit tests and system tests are described in the
@@ -93,8 +98,12 @@ On Debian/Ubuntu::
************
Coding Style
************
- We use the automatic code formatter ``black``. You can run it using
the nox session ``blacken``. This will eliminate many lint errors. Run via::

$ nox -s blacken

- PEP8 compliance, with exceptions defined in the linter configuration.
- PEP8 compliance is required, with exceptions defined in the linter configuration.
If you have ``nox`` installed, you can test that you have not introduced
any non-compliant code via::

@@ -133,13 +142,18 @@ Running System Tests

- To run system tests, you can execute::

$ nox -s system-3.7
# Run all system tests
$ nox -s system-3.8
$ nox -s system-2.7

# Run a single system test
$ nox -s system-3.8 -- -k <name of test>


.. note::

System tests are only configured to run under Python 2.7 and
Python 3.7. For expediency, we do not run them in older versions
Python 3.8. For expediency, we do not run them in older versions
of Python 3.

This alone will not run the tests. You'll need to change some local
@@ -4,7 +4,7 @@
"git": {
"name": ".",
"remote": "https://github.com/googleapis/python-bigquery.git",
"sha": "1823cadee3acf95c516d0479400e4175349ea199"
"sha": "1c6681aba872c00afb16a904a2ba9bae8e9618d3"
}
},
{
@@ -19,14 +19,14 @@
"git": {
"name": "synthtool",
"remote": "https://github.com/googleapis/synthtool.git",
"sha": "33366574ffb9e11737b3547eb6f020ecae0536e8"
"sha": "4679e7e415221f03ff2a71e3ffad75b9ec41d87e"
}
},
{
"git": {
"name": "synthtool",
"remote": "https://github.com/googleapis/synthtool.git",
"sha": "33366574ffb9e11737b3547eb6f020ecae0536e8"
"sha": "4679e7e415221f03ff2a71e3ffad75b9ec41d87e"
}
}
],
@@ -92,6 +92,7 @@
"CONTRIBUTING.rst",
"LICENSE",
"MANIFEST.in",
"bigquery-v2-py.tar.gz",
"docs/_static/custom.css",
"docs/_templates/layout.html",
"docs/bigquery_v2/services.rst",

0 comments on commit 01e851d

Please sign in to comment.