Skip to content

Commit

Permalink
Add style guide links to readme (#1241)
Browse files Browse the repository at this point in the history
* Add links to contributing and style guide

* Add style guide link to contributing
  • Loading branch information
leemunroe authored and bamarni committed May 22, 2018
1 parent cc1e941 commit fa0bfe7
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 2 deletions.
3 changes: 2 additions & 1 deletion CONTRIBUTING.md
Expand Up @@ -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](
Expand Down
6 changes: 5 additions & 1 deletion README.md
Expand Up @@ -214,7 +214,7 @@ run:

env/bin/tox -e py35-integration /<test-file>.py

### Releasing
## Releasing

Releasing a new version of the DC/OS CLI is only possible through an
[automated TeamCity
Expand All @@ -230,3 +230,7 @@ executables (for Windows, macOS, and Linux).

The executables are pushed to s3 and available at
<https://downloads.dcos.io/binaries/cli/>\<platform\>/x86-64/\<tag\>/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.

0 comments on commit fa0bfe7

Please sign in to comment.