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

Fix vale contractions #349

Merged
merged 4 commits into from
Feb 8, 2024
Merged

Fix vale contractions #349

merged 4 commits into from
Feb 8, 2024

Conversation

tanay1337
Copy link
Contributor

No description provided.

Copy link

github-actions bot commented Feb 8, 2024

Overall readability score: 68.75 (🟢 +0.03)

File Readability
bug-bounty.md 55.88 (🟢 +0.25)
safe-auth-pack.md 55.36 (🟢 +0.15)
monerium.md 73.97 (🟢 +0.13)
stripe.md 73 (🟢 +0.3)
sdk-protocol-kit.md 72.28 (🟢 +0.27)
gelato-relay.md 75.37 (🟢 +0.1)
eip-1271.md 72.82 (🟢 +0.05)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
bug-bounty.md 55.88 39.23 10.96 11.6 12.46 7.49
  🟢 +0.25 🟢 +0 🟢 +0.01 🟢 +0.1 🟢 +0.06 🟢 +0
safe-auth-pack.md 55.36 47.38 10.24 12.7 13.39 7.55
  🟢 +0.15 🟢 +0 🟢 +0 🟢 +0.1 🟢 +0 🟢 +0
monerium.md 73.97 57.37 8.25 8.9 10.14 6.48
  🟢 +0.13 🟢 +0 🟢 +0.01 🟢 +0 🟢 +0.06 🟢 +0.01
stripe.md 73 60.11 8.15 8.6 10.71 6.86
  🟢 +0.3 🔴 -0.1 🔴 -0.02 🟢 +0.1 🟢 +0.12 🟢 +0.01
sdk-protocol-kit.md 72.28 57.98 8.64 9.1 10.43 6.61
  🟢 +0.27 🟢 +0 🟢 +0.01 🟢 +0.1 🟢 +0.05 🟢 +0.01
gelato-relay.md 75.37 64 8.63 8.9 9.39 6.51
  🟢 +0.1 🔴 -0.1 🔴 -0.03 🟢 +0 🟢 +0.12 🟢 +0
eip-1271.md 72.82 57.06 8.03 9.8 10.55 6.35
  🟢 +0.05 🔴 -0.1 🔴 -0.03 🟢 +0 🟢 +0.06 🟢 +0.01

Averages:

  Readability FRE GF ARI CLI DCRS
Average 68.75 58.83 9.18 9.8 10.59 7.08
  🟢 +0.03 🔴 -0.01 🟢 +0 🟢 +0.01 🟢 +0.01 🟢 +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

@tanay1337 tanay1337 force-pushed the update-contractions-vale branch from f4887e4 to ecf738a Compare February 8, 2024 08:29
@tanay1337 tanay1337 requested a review from germartinez February 8, 2024 08:55
@germartinez
Copy link
Member

I found some more doing some manual checking, but I would remove contractions as they are meant to be used in colloquial language. Also this config file does not include all the pronouns I've, you've, we've, etc.

I would keep contractions just for negative forms and it's. I think it's easier and more elegant that way.

@tanay1337 tanay1337 requested a review from germartinez February 8, 2024 10:28
@tanay1337 tanay1337 merged commit 47d5716 into main Feb 8, 2024
1 of 3 checks passed
@tanay1337 tanay1337 deleted the update-contractions-vale branch February 8, 2024 10:52
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