From fa0bfe79dc938395b38b1272252a6eac08fe62aa Mon Sep 17 00:00:00 2001 From: Lee Munroe Date: Tue, 22 May 2018 00:05:41 -0700 Subject: [PATCH] Add style guide links to readme (#1241) * Add links to contributing and style guide * Add style guide link to contributing --- CONTRIBUTING.md | 3 ++- README.md | 6 +++++- 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5b0204da3..156a2ab99 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -18,10 +18,11 @@ If you are submitting a bug report, please include: Please describe the problem you are addressing and your proposed solution. ### Style -We follow [pep8](https://www.python.org/dev/peps/pep-0008/) and [isort]( +Please refer to our [style guide](https://github.com/dcos/dcos-cli/blob/master/STYLEGUIDE.md). We follow [pep8](https://www.python.org/dev/peps/pep-0008/) and [isort]( https://pypi.python.org/pypi/isort) conventions. You can make sure you follow these by running `tox -e py34-syntax` in the `dcos-cli` and `cli` directories. + ### Tests Please include test(s) with your changes. Make sure to separate integration and unit tests. Please use our test helpers for [integration tests]( diff --git a/README.md b/README.md index ad4016109..20127d102 100644 --- a/README.md +++ b/README.md @@ -214,7 +214,7 @@ run: env/bin/tox -e py35-integration /.py -### Releasing +## Releasing Releasing a new version of the DC/OS CLI is only possible through an [automated TeamCity @@ -230,3 +230,7 @@ executables (for Windows, macOS, and Linux). The executables are pushed to s3 and available at \/x86-64/\/dcos. + +## Contributing + +Contributions are always welcome! Please refer to our [contributing guidelines](https://github.com/dcos/dcos-cli/blob/master/CONTRIBUTING.md) and [style guide](https://github.com/dcos/dcos-cli/blob/master/STYLEGUIDE.md) first.