Skip to content
This repository has been archived by the owner on Jul 6, 2023. It is now read-only.


feat: add Samples section to CONTRIBUTING.rst (#84)
Browse files Browse the repository at this point in the history
Source-Link: googleapis/synthtool@52e4e46
  • Loading branch information
gcf-owl-bot[bot] committed Jul 22, 2021
1 parent 8caf981 commit 305dc83
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 1 deletion.
2 changes: 1 addition & 1 deletion .github/.OwlBot.lock.yaml
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
digest: sha256:5ff7446edeaede81c3ed58b23a4e76a5403fba1350ce28478045657303b6479d
digest: sha256:6186535cbdbf6b9fe61f00294929221d060634dae4a0795c1cefdbc995b2d605
24 changes: 24 additions & 0 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -177,6 +177,30 @@ Build the docs via:

$ nox -s docs

Samples and code snippets

Code samples and snippets live in the `samples/` catalogue. Feel free to
provide more examples, but make sure to write tests for those examples.
Each folder containing example code requires its own `` script
which automates testing. If you decide to create a new folder, you can
base it on the `samples/snippets` folder (providing `` and
the requirements files).

The tests will run against a real Google Cloud Project, so you should
configure them just like the System Tests.

- To run sample tests, you can execute::

# Run all tests in a folder
$ cd samples/snippets
$ nox -s py-3.8

# Run a single sample test
$ cd samples/snippets
$ nox -s py-3.8 -- -k <name of test>

Note About ``README`` as it pertains to PyPI
Expand Down

0 comments on commit 305dc83

Please sign in to comment.