Skip to content

Commit 534b875

Browse files
feat: add Samples section to CONTRIBUTING.rst (#211)
Source-Link: googleapis/synthtool@52e4e46 Post-Processor: gcr.io/repo-automation-bots/owlbot-python:latest@sha256:6186535cbdbf6b9fe61f00294929221d060634dae4a0795c1cefdbc995b2d605
1 parent 6bd4c1f commit 534b875

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

packages/google-cloud-python-speech/CONTRIBUTING.rst

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -177,6 +177,30 @@ Build the docs via:
177177

178178
$ nox -s docs
179179

180+
*************************
181+
Samples and code snippets
182+
*************************
183+
184+
Code samples and snippets live in the `samples/` catalogue. Feel free to
185+
provide more examples, but make sure to write tests for those examples.
186+
Each folder containing example code requires its own `noxfile.py` script
187+
which automates testing. If you decide to create a new folder, you can
188+
base it on the `samples/snippets` folder (providing `noxfile.py` and
189+
the requirements files).
190+
191+
The tests will run against a real Google Cloud Project, so you should
192+
configure them just like the System Tests.
193+
194+
- To run sample tests, you can execute::
195+
196+
# Run all tests in a folder
197+
$ cd samples/snippets
198+
$ nox -s py-3.8
199+
200+
# Run a single sample test
201+
$ cd samples/snippets
202+
$ nox -s py-3.8 -- -k <name of test>
203+
180204
********************************************
181205
Note About ``README`` as it pertains to PyPI
182206
********************************************

0 commit comments

Comments
 (0)