Skip to content

chore: apply repo-wide markdown formatter#93

Closed
paolomainardi wants to merge 1 commit into
mainfrom
chore/format-md-repo-wide
Closed

chore: apply repo-wide markdown formatter#93
paolomainardi wants to merge 1 commit into
mainfrom
chore/format-md-repo-wide

Conversation

@paolomainardi

Copy link
Copy Markdown
Member

🤖 This was written by an AI agent on behalf of @paolomainardi.

Summary

Applies the repository's markdown formatter (prettier via the project format recipe) across all tracked Markdown files. Pure mechanical reformatting, no content changes.

This is the collateral output of a formatter run triggered while working on #91. It was deliberately kept out of PR #92 (which was scoped to four files) and is split into this separate, content-free PR for a clean review.

Scope

130 Markdown files, formatting only: whitespace, line wrapping, list and table normalization. No prose, code, or semantic changes.

Assisted-by: claude-code/claude-opus-4-8
@paolomainardi paolomainardi deleted the chore/format-md-repo-wide branch June 5, 2026 22:23
@sparkfabrik-ai-bot

Copy link
Copy Markdown

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

🎫 Ticket compliance analysis 🔶

91 - Partially compliant

Compliant requirements:

  • None visible in this PR

Non-compliant requirements:

  • Add explicit caveman terse style carve-out to gh and glab skills
  • Add explicit caveman terse style carve-out to sf-commit-convention skill
  • Consolidate "write in plain prose" guidance in gh and glab into a single section per skill
  • State plainly that active terse style does not apply to titles, descriptions, comments, or reviews
  • Add section to sf-commit-convention covering commit subject/body and MR/PR titles

Requires further human verification:

92 - Partially compliant

Compliant requirements:

  • None visible in this PR

Non-compliant requirements:

  • Merge "write in plain prose" and caveman-override paragraphs in gh and glab
  • Add caveman carve-out statement to gh and glab
  • Add "Write in plain prose, not caveman" section to sf-commit-convention
  • Add consolidated CHANGELOG entry

Requires further human verification:

⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
🧪 No relevant tests
🔒 No security concerns identified
⚡ Recommended focus areas for review

Ticket Mismatch
This PR is described as a pure mechanical markdown formatter run, but the linked tickets (#91 and #92) require substantive content changes to gh, glab, and sf-commit-convention skills to add caveman terse style carve-outs. None of those content changes appear in this diff. The PR title and description explicitly state this is formatting-only, which means the ticket requirements are entirely unaddressed by this PR.

@sparkfabrik-ai-bot

Copy link
Copy Markdown

PR Code Suggestions ✨

Explore these optional code suggestions:

CategorySuggestion                                                                                                                                    Impact
Possible issue
Restore collapsed nested list structure

The formatter collapsed the nested sub-list items (Routes, Entity types, Plugins)
into a single run-on line, destroying the original list structure. This makes the
instructions significantly harder to read and follow. The sub-bullets should be
restored as a properly indented list under the parent item.

skills/drupal/drupal-major-upgrade-validation/SKILL.md [303-306]

 i. **Discover custom modules:** List modules under `web/modules/custom/`
-(and `addons/` if it exists). For each enabled custom module, gather: - Routes: check `<module>.routing.yml` for custom page/form routes - Entity types: check for `@ContentEntityType` or `@ConfigEntityType`
-annotations/attributes in `src/Entity/` - Plugins: check for block, field formatter, or field widget plugins
-in `src/Plugin/`
+   (and `addons/` if it exists). For each enabled custom module, gather:
+   - Routes: check `<module>.routing.yml` for custom page/form routes
+   - Entity types: check for `@ContentEntityType` or `@ConfigEntityType`
+     annotations/attributes in `src/Entity/`
+   - Plugins: check for block, field formatter, or field widget plugins
+     in `src/Plugin/`
Suggestion importance[1-10]: 6

__

Why: The PR's reformatting collapsed the nested sub-list items for step i into a run-on line, which significantly reduces readability of the instructions. The improved_code correctly restores the proper indented list structure, making this a valid and meaningful improvement.

Low
General
Avoid promoting closing remark to a heading

The original Good luck! followed by --- (a thematic break/horizontal rule) served as
a section separator before the next ## heading. Replacing it with ## Good luck!
promotes a closing remark to a section heading, which changes the document's
structure and may affect how the skill's table of contents or navigation is
rendered. Consider using a simple paragraph or keeping the thematic break instead of
a heading.

skills/system/skill-creator/SKILL.md [514]

--Good luck!
+Good luck!
+
 ---
-+## Good luck!
Suggestion importance[1-10]: 4

__

Why: The change from Good luck! + --- (thematic break) to ## Good luck! (heading) does alter the document structure, but the original --- was actually a horizontal rule separator, not a section divider in the traditional sense. Making it a heading is a reasonable stylistic choice, though it does change the document's heading hierarchy. The impact is minor.

Low
Preserve numeric precision in schema examples

The formatter changed "min": 0.80 to "min": 0.8 and "max": 0.90 to "max": 0.9 in the
JSON schema examples. While numerically equivalent, these are schema documentation
examples and the original trailing zeros were likely intentional to show the
expected precision/format of the values. Restoring them preserves the intended
schema documentation.

skills/system/skill-creator/references/schemas.md [262]

-"pass_rate": { "mean": 0.85, "stddev": 0.05, "min": 0.8, "max": 0.9 },
+"pass_rate": { "mean": 0.85, "stddev": 0.05, "min": 0.80, "max": 0.90 },
Suggestion importance[1-10]: 2

__

Why: The change from 0.80 to 0.8 and 0.90 to 0.9 is purely cosmetic in JSON schema documentation examples. While the original trailing zeros may have been intentional for consistency, this has no functional impact and is a very minor stylistic concern.

Low

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant