Skip to content

Conversation

ABaldwinHunter
Copy link
Contributor

cc @codeclimate/review

@wfleming
Copy link
Contributor

nice 👍

FWIW, you might want to extract the docs URL to a named markdown URL at the bottom of the page or something. If we ever ended up changing that URL for any reason, there's an excellent chance we'd remember to change one of these & not the other.

I believe the syntax works like this:

[RuboCop engine documentation][cc-docs-rubocop]



[cc-docs-rubocop]: https://docs.codeclimate.com/docs/rubocop

README.md Outdated
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Personal opinion, but I think "here" is redundant in the link text. It's a link, and it's "RuboCop engine documentation": I don't think more is required.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 sounds good

@ABaldwinHunter
Copy link
Contributor Author

@wfleming thanks great idea!

Added link

@wfleming
Copy link
Contributor

:shipit:

ABaldwinHunter pushed a commit that referenced this pull request Jan 13, 2016
link to codelcimate docs in readme
@ABaldwinHunter ABaldwinHunter merged commit 3c6f4ea into master Jan 13, 2016
@ABaldwinHunter ABaldwinHunter deleted the abh-readme-docs-link branch January 13, 2016 19:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants