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

feat: Readability score is not out of 100 #32

Merged
merged 6 commits into from
Jul 26, 2023

Conversation

Weetbix
Copy link
Collaborator

@Weetbix Weetbix commented Jul 26, 2023

This PR updates the readability score so that it is not shown as being out of 100. Showing the score as out of 100 is not really useful, and might lead to users thinking they should be aiming for 100/100. In reality the goal score could depend on your intended content complexity, and any increase in the number is an improvement.

Changes:

  • Updates reporter
  • Updates playground
image

@github-actions
Copy link

github-actions bot commented Jul 26, 2023

Overall readability score: 57.69 (🟢 +4.23)

File Readability
README.md 62.1 (🟢 +1.67)
onboarding.md 58.9 (🟢 +3.2)
july-blog.md 52.34 (🔴 -4.23)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
README.md 12.4 14.56 18.81 25.5 14.69 8.3
  🔴 -1.67 🔴 -0.61 🔴 -0.32 🔴 -0.5 🔴 -0.12 🔴 -0.04

Averages:

  Readability FRE GF ARI CLI DCRS
Average 17.69 6.61 17.48 18.38 15.82 9.68
  🔴 -0.42 🔴 -0.15 🔴 -0.08 🔴 -0.13 🔴 -0.03 🔴 -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

@Weetbix Weetbix requested a review from noon-dawg July 26, 2023 05:13
@Weetbix Weetbix self-assigned this Jul 26, 2023
playground/src/App.vue Outdated Show resolved Hide resolved
noon-dawg
noon-dawg previously approved these changes Jul 26, 2023
@Weetbix
Copy link
Collaborator Author

Weetbix commented Jul 26, 2023

@noon-dawg had to merge! pls re-tick :)

@Weetbix Weetbix merged commit 9c30a52 into main Jul 26, 2023
5 checks passed
@Weetbix Weetbix deleted the jh/readability-score-is-not-out-of-100 branch July 26, 2023 12:12
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