Skip to content

Commit da3be4e

Browse files
committed
Add style guide information to CONTRIBUTING.md.
Rather than use https://github.com/GoogleCloudPlatform/Template/wiki/style.html I want to have that page link to the appropriate repos.
1 parent f29f26d commit da3be4e

File tree

1 file changed

+14
-4
lines changed

1 file changed

+14
-4
lines changed

CONTRIBUTING.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,23 @@ be able to accept your pull requests.
2727
Contributor License Agreement (see details above).
2828
1. Fork the desired repo, develop and test your code changes.
2929
1. Ensure that your code adheres to the existing style in the sample to which
30-
you are contributing. Refer to the
31-
[Google Cloud Platform Samples Style Guide]
32-
(https://github.com/GoogleCloudPlatform/Template/wiki/style.html) for the
33-
recommended coding standards for this organization.
30+
you are contributing.
3431
1. Ensure that your code has an appropriate set of unit tests which all pass.
3532
1. Submit a pull request.
3633

34+
## Style
35+
36+
Samples in this repository follow the [Google Python Style
37+
Guide](https://google.github.io/styleguide/pyguide.html). This is enforced using
38+
the [flake8](https://pypi.python.org/pypi/flake8) tool.
39+
40+
To use the same flake8 configuration as is used in the automated test suite,
41+
install [nox](https://nox.readthedocs.io/en/latest/) and run
42+
43+
```shell
44+
nox -s lint -- path/to/sample
45+
```
46+
3747
## Testing
3848

3949
See [TESTING.md](TESTING.md).

0 commit comments

Comments
 (0)