Skip to content

Commit

Permalink
Add style guide information to CONTRIBUTING.md.
Browse files Browse the repository at this point in the history
Rather than use
https://github.com/GoogleCloudPlatform/Template/wiki/style.html I want
to have that page link to the appropriate repos.
  • Loading branch information
tswast committed Aug 25, 2016
1 parent f29f26d commit da3be4e
Showing 1 changed file with 14 additions and 4 deletions.
18 changes: 14 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,23 @@ 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 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).

0 comments on commit da3be4e

Please sign in to comment.