Skip to content

feat: Add Intellij Guardrails documentation#2458

Closed
lventura-codacy wants to merge 2 commits into
masterfrom
intellij-guardrails
Closed

feat: Add Intellij Guardrails documentation#2458
lventura-codacy wants to merge 2 commits into
masterfrom
intellij-guardrails

Conversation

@lventura-codacy
Copy link
Copy Markdown
Contributor

👀 Live preview

🚧 To do

  • If relevant, include the Jira issue key at the end of the pull request title
  • Perform a self-review of the changes
  • Fix any issues reported by the CI/CD

@lventura-codacy lventura-codacy requested a review from a team as a code owner August 28, 2025 10:21
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Aug 28, 2025

Overall readability score: 52.92 (🟢 +0.08)

File Readability
integrating-codacy-with-intellij-ides.md 67.8 (🟢 +0.87)
codacy-guardrails-limitations.md 45.27 (🟢 +18.34)
codacy-guardrails-getting-started.md 57.68 (🟢 +0.02)
View detailed metrics

🟢 - Shows an increase in readability
🔴 - Shows a decrease in readability

File Readability FRE GF ARI CLI DCRS
integrating-codacy-with-intellij-ides.md 67.8 53.1 10.21 10.4 9.51 6.73
  🟢 +0.87 🟢 +0.3 🟢 +0.24 🟢 +0.1 🟢 +0.3 🔴 -0.05
codacy-guardrails-limitations.md 45.27 42.55 14.91 15.9 10.39 7.82
  🟢 +18.34 🟢 +7.27 🟢 +4.09 🟢 +6.1 🔴 -1.09 🟢 +0.87
codacy-guardrails-getting-started.md 57.68 47.22 11.89 13.8 10.57 6.68
  🟢 +0.02 🔴 -2.84 🔴 -0.24 🔴 -0.9 🟢 +0.11 🟢 +0.64

Averages:

  Readability FRE GF ARI CLI DCRS
Average 52.92 42.67 10.98 12.72 12.63 7.99
  🟢 +0.08 🟢 +0.02 🟢 +0.02 🟢 +0.02 🟢 +0 🟢 +0.01
View metric targets
Metric Range Ideal score
Flesch Reading Ease 100 (very easy read) to 0 (extremely difficult read) 60
Gunning Fog 6 (very easy read) to 17 (extremely difficult read) 8 or less
Auto. Read. Index 6 (very easy read) to 14 (extremely difficult read) 8 or less
Coleman Liau Index 6 (very easy read) to 17 (extremely difficult read) 8 or less
Dale-Chall Readability 4.9 (very easy read) to 9.9 (extremely difficult read) 6.9 or less

@github-actions github-actions Bot temporarily deployed to Netlify August 28, 2025 10:22 Inactive
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.

1 participant