Use semantic breaks to ease editing
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 24
- Forks
- 15
- Avg merge
- 10d 3h
- Merged PRs (30d)
- 1
Description
Use semantic breaks to ease editing. Put each sentence on separate lines to simplify diffing and improve readability in text editors.
- Semantic Breaks: https://sembr.org/
This would be a gradual transition as we have nearly 8,000 lines of text that would easily rise into the tens-of-thousands.
Ultimately, this could be enforced through the use of a custom linting rule for markdownlint or another tool. An example is here: https://github.com/JoshuaKGoldberg/sentences-per-line. It could be included as a sub-repository in a special subfolder, and then included into the markdownlint configuration.
We can start by adding it to vscode-markdownlint for in-IDE checking, then moving up to pre-commit and CI checking.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the repository's Markdown content and existing markdownlint configuration; the issue names no specific files. Review vscode-markdownlint and the referenced semantic-break approach, then determine how the rule could move gradually into pre-commit and CI. Done means sentence-per-line formatting is checked consistently without requiring an immediate rewrite of all text.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown, vscode
- Domain
- ci-cd, documentation, tooling
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100