Back to all reviewers

markdown formatting consistency

mastodon/mastodon
Based on 2 comments
Markdown

Establish and maintain consistent formatting standards for Markdown files to improve readability and maintainability. This includes adhering to line length limits and consistent styling choices within documents.

Code Style Markdown

Reviewer Prompt

Establish and maintain consistent formatting standards for Markdown files to improve readability and maintainability. This includes adhering to line length limits and consistent styling choices within documents.

Key guidelines:

  • Hard wrap Markdown files at 80 characters for better diff reviews and readability
  • Maintain consistency in link formatting styles within each document (either all footnote-style or all inline)
  • Match existing formatting patterns in the codebase when making changes

Example of proper line wrapping:

These terms of service (the "Terms") cover your access and use of Server 
Operator's ("Administrator" we," or "us") instance, located at %{domain} 
(the "Instance"). These Terms apply solely to your use of the Instance as 
operated by the Administrator.

This approach makes documents easier to read in editors, creates cleaner diffs when links change, and ensures a professional, consistent appearance across all documentation.

2
Comments Analyzed
Markdown
Primary Language
Code Style
Category

Source Discussions