Semantic Line Breaks

Acerca de

This skill guides the formatting of prose in technical writing, such as multi-line comments, commit messages, and Markdown documentation. It enforces the practice of 'semantic line breaks,' which involves breaking lines at logical points within the text—like after a sentence or a clause—rather than wrapping arbitrarily at a fixed character limit. Following these guidelines makes text easier to read, review, and edit, as changes are localized to specific lines, resulting in cleaner version control diffs.

Características Principales

• Defines rules for breaking lines at logical points, such as after sentences or clauses.
• Provides specific line length limits for commit messages, code comments, and Markdown.
• Includes best practices for handling lists, hyperlinks, and hyphenated words.
• Enforces formatting that improves readability and simplifies version control diffs.
• Automatically applies guidance when writing multi-line comments, commit messages, or Markdown.
• 11 GitHub stars

Casos de Uso

• Writing clear and maintainable multi-line code comments.
• Crafting well-formatted, easy-to-review Git commit messages.
• Authoring readable and maintainable technical documentation in Markdown.