Skip to content

Commit 3c6f4ea

Browse files
author
Ashley Baldwin-Hunter
committed
Merge pull request #45 from codeclimate/abh-readme-docs-link
link to codelcimate docs in readme
2 parents 9523ce2 + da60ff0 commit 3c6f4ea

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

README.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66

77
RuboCop helps you enforce many of the guidelines outlined in the community [Ruby Style Guide](https://github.com/bbatsov/ruby-style-guide). Most aspects of its behavior can be tweaked via various [configuration options](https://github.com/bbatsov/rubocop/blob/master/config/default.yml), which are set in a **.rubocop.yml** file.
88

9+
You can find some basic setup instructions and links to the RuboCop OSS project below. For additional Code Climate-specific config details, check out our [RuboCop engine documentation][cc-docs-rubocop].
10+
911
### Installation
1012

1113
1. If you haven't already, [install the Code Climate CLI](https://github.com/codeclimate/codeclimate).
@@ -16,4 +18,6 @@ RuboCop helps you enforce many of the guidelines outlined in the community [Ruby
1618

1719
For help with RuboCop, [check out their documentation](https://github.com/bbatsov/rubocop).
1820

19-
If you're running into a Code Climate issue, first look over this project's [GitHub Issues](https://github.com/codeclimate/codeclimate-rubocop/issues), as your question may have already been covered. If not, [go ahead and open a support ticket with us](https://codeclimate.com/help).
21+
If you're running into a Code Climate issue, first check out [our RuboCop engine docs][cc-docs-rubocop] and look over this project's [GitHub Issues](https://github.com/codeclimate/codeclimate-rubocop/issues), as your question may have already been covered. If not, [go ahead and open a support ticket with us](https://codeclimate.com/help).
22+
23+
[cc-docs-rubocop]: https://docs.codeclimate.com/docs/rubocop

0 commit comments

Comments
 (0)