Skip to content

remove Quality refs from docs #2370

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

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

DMarinhoCodacy
Copy link
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

@DMarinhoCodacy DMarinhoCodacy requested review from a team as code owners April 1, 2025 18:42
Copy link
Contributor

github-actions bot commented Apr 1, 2025

Overall readability score: 53.27 (🟢 +0.02)

File Readability
adjusting-quality-goals.md 66.54 (🟢 +0)
adjusting-quality-gates.md 59.39 (🟢 +0)
repository-dashboard.md 63.1 (🟢 +0.72)
pull-requests.md 66.22 (🟢 +0.12)
issues.md 64.79 (🟢 +0.15)
files.md 72.26 (🟢 +0.43)
coverage.md 68.45 (🟢 +0.42)
commits.md 51.38 (🟢 +0.29)
integrating-codacy-with-visual-studio-code.md 68.03 (🟢 +0.97)
integrating-codacy-with-intellij-ides.md 66.94 (🟢 +1.08)
which-metrics-does-codacy-calculate.md 59.64 (🔴 -0.02)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
adjusting-quality-goals.md 66.54 44 8.02 9.5 12.27 7.02
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
adjusting-quality-gates.md 59.39 45.05 10.99 11.5 11.31 7.23
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
repository-dashboard.md 63.1 44.54 9.88 11.5 11.13 6.72
  🟢 +0.72 🟢 +0.1 🟢 +0.03 🟢 +0.1 🟢 +0.36 🟢 +0
pull-requests.md 66.22 55.34 9.99 10.1 10.61 7.11
  🟢 +0.12 🟢 +0.1 🟢 +0.03 🟢 +0 🟢 +0.06 🔴 -0.01
issues.md 64.79 47.28 9.64 10.4 11.02 7.01
  🟢 +0.15 🟢 +0 🟢 +0.05 🟢 +0 🟢 +0 🟢 +0.02
files.md 72.26 57.27 8.76 9.2 10.43 6.47
  🟢 +0.43 🟢 +0 🟢 +0.06 🟢 +0.1 🟢 +0.06 🟢 +0.03
coverage.md 68.45 48.5 8.29 10.5 11.77 6.28
  🟢 +0.42 🟢 +0 🟢 +0.11 🟢 +0 🟢 +0.05 🟢 +0.05
commits.md 51.38 33.65 11.07 15.2 13 6.68
  🟢 +0.29 🟢 +0.11 🟢 +0.08 🟢 +0 🟢 +0.05 🟢 +0.02
integrating-codacy-with-visual-studio-code.md 68.03 52.9 10 10.7 9.98 6.42
  🟢 +0.97 🟢 +0.3 🟢 +0.11 🟢 +0.3 🟢 +0.23 🔴 -0.01
integrating-codacy-with-intellij-ides.md 66.94 52.8 10.45 10.5 9.81 6.68
  🟢 +1.08 🟢 +0.31 🟢 +0.14 🟢 +0.3 🟢 +0.23 🟢 +0.01
which-metrics-does-codacy-calculate.md 59.64 38.42 9.61 12 13.05 6.56
  🔴 -0.02 🟢 +0 🔴 -0.01 🟢 +0 🟢 +0 🟢 +0

Averages:

  Readability FRE GF ARI CLI DCRS
Average 53.27 42.76 10.87 12.64 12.69 7.96
  🟢 +0.02 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
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 April 1, 2025 18:54 Inactive
@github-actions github-actions bot temporarily deployed to Netlify April 8, 2025 10:15 Inactive
@github-actions github-actions bot temporarily deployed to Netlify April 10, 2025 08:07 Inactive
@@ -96,7 +96,7 @@ Codacy displays complexity on the following places:

## Duplication

Codacy identifies clones or [sequences of duplicate code](https://en.wikipedia.org/wiki/Duplicate_code) that exist in at least two different places of the source code of your repository. Clones typically indicate deeper code quality issues and should be eliminated through abstraction when possible.
Codacy identifies clones or [sequences of duplicate code](https://en.wikipedia.org/wiki/Duplicate_code) that exist in at least two different places of the source code of your repository. Clones typically indicate deeper code issues and should be eliminated through abstraction when possible.

Choose a reason for hiding this comment

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

@DMarinhoCodacy here we can keep "quality" because it refers to duplication which is a quality metric

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