Semantic Line Breaks

Name: Semantic Line Breaks
Author: abhinav

•

Applies semantic line breaks to prose, such as comments and commit messages, to improve readability and maintainability.

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.

主な機能

01Defines rules for breaking lines at logical points, such as after sentences or clauses.

02Provides specific line length limits for commit messages, code comments, and Markdown.

03Includes best practices for handling lists, hyperlinks, and hyphenated words.

04Enforces formatting that improves readability and simplifies version control diffs.

05Automatically applies guidance when writing multi-line comments, commit messages, or Markdown.

0611 GitHub stars

ユースケース

01Writing clear and maintainable multi-line code comments.

02Crafting well-formatted, easy-to-review Git commit messages.

03Authoring readable and maintainable technical documentation in Markdown.

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add abhinav/home semantic-line-breaks

For use in Claude.ai and ChatGPT

Download Skill