Skip to content
Open
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,3 +31,35 @@ pytest -m integration
```

For detailed information about writing and maintaining integration tests, see [docs/INTEGRATION_TESTING.md](docs/INTEGRATION_TESTING.md).

Copy link
Collaborator

Choose a reason for hiding this comment

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

Thanks for thinking about documentation! I think our README is pretty high level so instead you can add this command to the commands wiki.

## Readability Check

We use a readability check tool to ensure translation content is accessible to users with varying reading levels. The tool analyzes text using industry-standard metrics:

- **English**: Flesch-Kincaid Grade Level (target: 8th grade or below)
- **Spanish**: Fernández-Huerta score (target: 60+ for good readability)

### Running Readability Checks

```bash
# Check all English translations
python manage.py check_readability --language en-us

# Check English for specific white-label (Colorado)
python manage.py check_readability --language en --whitelabel co

# Check Spanish translations
python manage.py check_readability --language es --whitelabel co

# With custom threshold (6th grade level)
python manage.py check_readability --language en --whitelabel co --threshold 6

# Show detailed scores for each translation
python manage.py check_readability --language en --whitelabel co --detailed

# CI/CD mode - exit with error code if failures found
python manage.py check_readability --language en --whitelabel co --fail-on-error

# Also show passing translations
python manage.py check_readability --language en --whitelabel co --show-passing
```
1 change: 1 addition & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,7 @@ soupsieve==2.4.1
sqlparse==0.5.0
starkbank-ecdsa==2.2.0
tablib==3.5.0
textstat>=0.7.3
tomli==2.2.1
tqdm==4.66.3
twilio==7.16.3
Expand Down
Loading