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

doc: add documentation for open issues ALA-1419 #2342

Merged
merged 2 commits into from
Feb 7, 2025

Conversation

alerizzo
Copy link
Contributor

@alerizzo alerizzo commented Feb 6, 2025

👀 Live preview

https://doc-organization-metrics--docs-codacy.netlify.app/organizations/organization-overview/
https://doc-organization-metrics--docs-codacy.netlify.app/organizations/issues-metrics/

🚧 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

@alerizzo alerizzo requested a review from a team as a code owner February 6, 2025 17:25
@alerizzo alerizzo requested a review from a team February 6, 2025 17:25
Copy link
Contributor

github-actions bot commented Feb 6, 2025

Overall readability score: 53.64 (🟢 +0.02)

File Readability
issues-metrics.md 64.87 (-)
organization-overview.md 47.82 (🔴 -6.04)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
issues-metrics.md 64.87 43.53 9.94 11.3 10.62 6.4
  - - - - - -
organization-overview.md 47.82 33.14 11.76 14.6 13.4 7.49
  🔴 -6.04 🔴 -2.13 🔴 -1.11 🔴 -1.5 🔴 -0.52 🔴 -0.27

Averages:

  Readability FRE GF ARI CLI DCRS
Average 53.64 42.8 10.83 12.54 12.61 7.94
  🟢 +0.02 🔴 -0.01 🟢 +0 🟢 +0 🟢 +0.01 🟢 +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 February 6, 2025 17:44 Inactive
@alerizzo alerizzo merged commit 9f05864 into master Feb 7, 2025
6 checks passed
@alerizzo alerizzo deleted the doc--organization-metrics branch February 7, 2025 11:02
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