Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add style guide information to CONTRIBUTING.md. #481

Merged
merged 2 commits into from
Aug 26, 2016
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 15 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,24 @@ be able to accept your pull requests.
Contributor License Agreement (see details above).
1. Fork the desired repo, develop and test your code changes.
1. Ensure that your code adheres to the existing style in the sample to which
you are contributing. Refer to the
[Google Cloud Platform Samples Style Guide]
(https://github.com/GoogleCloudPlatform/Template/wiki/style.html) for the
recommended coding standards for this organization.
you are contributing.
1. Ensure that your code has an appropriate set of unit tests which all pass.
1. Submit a pull request.

## Style

Samples in this repository follow [PEP
8](https://www.python.org/dev/peps/pep-0008/) and the [Google Python Style
Guide](https://google.github.io/styleguide/pyguide.html). This is enforced using
the [flake8](https://pypi.python.org/pypi/flake8) tool.

To use the same flake8 configuration as is used in the automated test suite,
install [nox](https://nox.readthedocs.io/en/latest/) and run

```shell
nox -s lint -- path/to/sample
```

## Testing

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