From 43430e5839a2327f03791ca349006b26aa0534fd Mon Sep 17 00:00:00 2001 From: Marcelo Toledo Date: Thu, 6 Jun 2019 21:05:07 -0300 Subject: [PATCH] Small text adjustments Update URL and Markdown syntaxe --- DEVELOPERS.md | 6 +++--- README.md | 6 +++--- lib/tasks/docs.rake | 2 +- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/DEVELOPERS.md b/DEVELOPERS.md index fb7b423c..68b34df8 100644 --- a/DEVELOPERS.md +++ b/DEVELOPERS.md @@ -1,4 +1,4 @@ -Information for engine developers & contributors +# Information for engine developers & contributors ## Testing local changes @@ -13,7 +13,7 @@ against real repos using the Code Climate CLI. If you are upgrading to a new version of RuboCop, please re-run the doc scraper to get any new or updated docs: -``` +```sh docker run \ --rm --volume "$PWD:/usr/src/app" --user root --workdir /usr/src/app \ codeclimate/codeclimate-rubocop bundle exec rake docs:scrape @@ -26,7 +26,7 @@ You should add any new cops without docs that fail specs to When doing QA, it's good to confirm the engine will run successfully when using the default inferred configuration: -``` +```sh rm .rubocop.yml codeclimate init --upgrade codeclimate analyze -e rubocop diff --git a/README.md b/README.md index e9132e77..d28f7466 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,9 @@ [![Code Climate](https://codeclimate.com/github/codeclimate/codeclimate-rubocop/badges/gpa.svg)](https://codeclimate.com/github/codeclimate/codeclimate-rubocop) -`codeclimate-rubocop` is a Code Climate engine that wraps the [RuboCop](https://github.com/bbatsov/rubocop) static analysis tool. You can run it on your command line using the Code Climate CLI, or on our hosted analysis platform. +`codeclimate-rubocop` is a Code Climate engine that wraps the [RuboCop](https://github.com/rubocop-hq/rubocop) static analysis tool. You can run it on your command line using the Code Climate CLI, or on our hosted analysis platform. -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. +RuboCop helps you enforce many of the guidelines outlined in the community [Ruby Style Guide](https://github.com/rubocop-hq/ruby-style-guide). Most aspects of its behavior can be tweaked via various [configuration options](https://github.com/rubocop-hq/rubocop/blob/master/config/default.yml), which are set in a **.rubocop.yml** file. 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]. @@ -16,7 +16,7 @@ You can find some basic setup instructions and links to the RuboCop OSS project ### Need help? -For help with RuboCop, [check out their documentation](https://github.com/bbatsov/rubocop). +For help with RuboCop, [check out their documentation](https://github.com/rubocop-hq/rubocop). 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). diff --git a/lib/tasks/docs.rake b/lib/tasks/docs.rake index c8ed19bc..e0498811 100644 --- a/lib/tasks/docs.rake +++ b/lib/tasks/docs.rake @@ -9,7 +9,7 @@ namespace :docs do MIN_LINES = 3 COP_FOLDERS = %w[bundler gemspec layout lint metrics naming performance rails security style].freeze - `git clone https://github.com/bbatsov/rubocop.git rubocop-git` + `git clone https://github.com/rubocop-hq/rubocop rubocop-git` `cd rubocop-git && git checkout tags/v#{RuboCop::Version.version}` files = Dir.glob("./rubocop-git/lib/rubocop/cop/{#{COP_FOLDERS.join(",")}}/**.rb")