Skip to content

Commit 0f9184d

Browse files
feat: add Samples section to CONTRIBUTING.rst (#401)
Source-Link: googleapis/synthtool@52e4e46 Post-Processor: gcr.io/repo-automation-bots/owlbot-python:latest@sha256:6186535cbdbf6b9fe61f00294929221d060634dae4a0795c1cefdbc995b2d605
1 parent 9506ed1 commit 0f9184d

File tree

2 files changed

+25
-1
lines changed

2 files changed

+25
-1
lines changed

.github/.OwlBot.lock.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
docker:
22
image: gcr.io/repo-automation-bots/owlbot-python:latest
3-
digest: sha256:5ff7446edeaede81c3ed58b23a4e76a5403fba1350ce28478045657303b6479d
3+
digest: sha256:6186535cbdbf6b9fe61f00294929221d060634dae4a0795c1cefdbc995b2d605

CONTRIBUTING.rst

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

188188
$ nox -s docs
189189

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

0 commit comments

Comments
 (0)