SSWConsulting / SSWConsulting/SSW.Rules

♻️ Normalize formatting across Rules V3 to reduce noisy pull requests

Open
#2,375 2 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

01-small YakShaver
Dominant language
TypeScript
Stars
26
Forks
17
Avg merge
14h 39m
Merged PRs (30d)
2

Description

Requested by: @KostaMadorsky via YakShaver.ai 🦬
cc: @KostaMadorsky, @Marxoz, @PothieuG, @Freego1783, @adamcogan

Hi Team!

  🟥  Watch the video (1 min 13 sec)

Pain

After migrating to Rules V3 (TinaCMS), small content changes result in large pull requests due to widespread automatic formatting differences. This makes it difficult to review and identify the actual intent of changes. Introduce a one-time or standardized formatting approach across all rules so that future pull requests only reflect meaningful content changes rather than formatting noise.

Acceptance Criteria
  1. A consistent formatting standard is defined for Rules V3 (TinaCMS) files.
  2. All existing rules are formatted using the agreed standard in a single, dedicated change.
  3. After formatting normalization, small edits (e.g., adding an end intro tag or minor text changes) result in minimal and clearly visible diffs.
  4. Formatting rules are documented or enforced (e.g., via tooling or CI) to prevent future drift.
  5. No functional behavior of existing rules is changed as part of the formatting normalization.
Screenshot

Screenshot
Figure: Small code changes obscured by extensive formatting differences in a pull request

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Locate the Rules V3 (TinaCMS) files and inspect any existing formatting configuration or CI checks. Determine how the formatting standard can be applied without functional changes, then verify that a small content edit produces a minimal diff and that formatting is documented or enforced.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
content
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.