Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve readme #170

Merged
merged 3 commits into from
Jan 18, 2023
Merged

Improve readme #170

merged 3 commits into from
Jan 18, 2023

Conversation

TWiStErRob
Copy link
Contributor

@TWiStErRob TWiStErRob commented Jan 5, 2023

Changes

  • Restructured hierarchy a bit so nesting is cleaner.
  • Revised headers for clarity (minimize wording, remove redundant words, use Detekt terminology)
  • Added local rule configuration as the first config, as most of the users will configure via local detekt.yml, not a remote URL.
  • Added real example of plugin usage
  • Moved "local Detekt plugins" section lower down, as it's more likely people will use plugins from Maven repos.
  • Added links to Detekt docs for easy access.

Visual

For testing, preview is available at this PR's branch HEAD.

Before After
image image

Admin

Feel free to squash these commits on merge.

@TWiStErRob
Copy link
Contributor Author

cc @dmitry-weirdo thoughts as a user?

@codecov-commenter
Copy link

Codecov Report

Merging #170 (bd92f80) into main (9a29854) will not change coverage.
The diff coverage is n/a.

@@            Coverage Diff            @@
##               main     #170   +/-   ##
=========================================
  Coverage     73.93%   73.93%           
  Complexity       37       37           
=========================================
  Files             9        9           
  Lines           165      165           
  Branches         39       39           
=========================================
  Hits            122      122           
  Misses           17       17           
  Partials         26       26           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@Ozsie Ozsie merged commit f3db183 into Ozsie:main Jan 18, 2023
@TWiStErRob TWiStErRob deleted the patch-1 branch January 18, 2023 16:16
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.

3 participants