Skip to content

chore: align the repository hygiene - #552

Merged
uniqueg merged 2 commits into
devfrom
chore/align-hygiene-551
Nov 2, 2026
Merged

uniqueg merged 2 commits into
devfrom
chore/align-hygiene-551

Conversation

@uniqueg

@uniqueg uniqueg commented Nov 2, 2026 •

Copy link
Copy Markdown
Member

Closes #551

Summary

  • README: markdownlint comments around the logo; Docs badge before Coverage; branch in the Coverage badge and link, as in the other READMEs.
  • .github/dependabot.yml: add a grouped, monthly docker entry for the Dockerfile.

No component source is touched. An npm entry is left out on purpose: it would bump the dependencies of packages/*, which is @anuragxxd's call.

Light lane: docs and configuration only. The diff was reviewed by the author.

Verification

.github/dependabot.yml parses as YAML. The local lint and tests did not run, as neither covers these two files (and npm install in CC clones has filled the disk before); CI runs them.

🤖 Generated with Claude Code

https://claude.ai/code/session_011FSoqMUX3EU35poH13xMgG

Summary by Sourcery

Align repository documentation and dependency-update configuration with established hygiene conventions.

Enhancements:

  • Align README badge ordering and coverage links with repository conventions, while documenting the intentional markdownlint exceptions for the logo.

Documentation:

  • Update the README’s badge presentation and coverage references for the dev branch.

Chores:

  • Configure monthly grouped Dependabot updates for Docker image dependencies.

Add the markdownlint comments around the logo, put the Docs badge
before Coverage, and name the branch in the Coverage badge and link.

Refs #551
Add a grouped, monthly docker entry, so that the base image of the
Dockerfile gets updates.

Refs #551
@sourcery-ai

sourcery-ai Bot commented Nov 2, 2026 •

Copy link
Copy Markdown
Contributor
Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

This documentation- and configuration-only change standardizes README lint annotations and badge links/order, and adds monthly grouped Dependabot updates for Docker dependencies without changing component source or npm dependency management.

File-Level Changes

Change Details Files
Align README markup and badge configuration with repository conventions.
  • Add scoped markdownlint exceptions for the logo-first dark-mode markup.
  • Reorder Docs before Coverage and update Coverage badge/image links to target the dev branch explicitly.
README.md
Configure grouped monthly Dependabot updates for Docker dependencies.
  • Add a root-level Docker ecosystem update entry for the Dockerfile.
  • Group all Docker updates and use the build commit prefix on a monthly schedule.
.github/dependabot.yml

Possibly linked issues


Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@codecov

codecov Bot commented Nov 2, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 70.89%. Comparing base (3b06f7a) to head (561b0a7).

Additional details and impacted files
@@           Coverage Diff           @@
##              dev     #552   +/-   ##
=======================================
  Coverage   70.89%   70.89%           
=======================================
  Files          23       23           
  Lines        5638     5638           
  Branches      190      190           
=======================================
  Hits         3997     3997           
  Misses       1636     1636           
  Partials        5        5           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@uniqueg
uniqueg marked this pull request as ready for review November 2, 2026 17:04
@uniqueg
uniqueg requested a review from anuragxxd as a code owner November 2, 2026 17:04

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've reviewed your changes and they look great!

Linked issues

#551 chore: align the repository hygiene · 4 of 4 met

# Requirement Status Notes
1 Add markdownlint comments around the logo block ✅ Met The README disables MD033 and MD041 around the logo, then re-enables them.
2 Put the Docs badge before the Coverage badge ✅ Met
3 Name the branch in the Coverage badge and its link ✅ Met Both coverage URLs specify the dev branch.
4 Add a grouped, monthly Docker Dependabot entry for the Dockerfile ✅ Met The Docker ecosystem entry targets the repository root, runs monthly, and groups updates under docker.

Sourcery assessment

Approved.


Sourcery is free for open source - if you like our reviews please consider sharing them ✨

@uniqueg
uniqueg merged commit 955cdad into dev Nov 2, 2026
25 checks passed
@uniqueg
uniqueg deleted the chore/align-hygiene-551 branch November 2, 2026 17:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

chore: align the repository hygiene

1 participant