Skip to content

Add Package Readme Files#936

Merged
omermorad merged 6 commits into
masterfrom
docs/packages-readme-files
Dec 8, 2025
Merged

Add Package Readme Files#936
omermorad merged 6 commits into
masterfrom
docs/packages-readme-files

Conversation

@omermorad

@omermorad omermorad commented Nov 24, 2025

Copy link
Copy Markdown
Collaborator

PR Checklist

Please check if your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Other... Please describe: Documentation

What is the current behavior?

The npm packages (@suites/di.inversify, @suites/di.nestjs, @suites/doubles.jest, @suites/doubles.sinon, @suites/doubles.vitest, @suites/unit) do not have comprehensive README files for display on npm.

Issue Number: N/A

What is the new behavior?

Each package now has a detailed README file with:

  • Logo section with Suites logo and framework-specific logo
  • Package description and badges (npm version, downloads, license)
  • "What is" section explaining the package purpose
  • Quick Start code example
  • Installation instructions
  • Key Features list
  • Framework-specific patterns/API documentation
  • Links to documentation
  • Other adapters section
  • Support & Community links
  • Contributing and License sections

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

Packages updated:

  • @suites/di.inversify
  • @suites/di.nestjs
  • @suites/doubles.jest
  • @suites/doubles.sinon
  • @suites/doubles.vitest
  • @suites/unit

@omermorad omermorad changed the title docs: packages readme files [skip ci] docs: packages readme files Nov 24, 2025
@codecov

codecov Bot commented Nov 24, 2025

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 92.94%. Comparing base (775e5a1) to head (2b7e783).
⚠️ Report is 6 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #936   +/-   ##
=======================================
  Coverage   92.94%   92.94%           
=======================================
  Files          26       26           
  Lines         595      595           
  Branches       99       99           
=======================================
  Hits          553      553           
  Misses         33       33           
  Partials        9        9           
Flag Coverage Δ
core.unit 93.44% <ø> (ø)
di.inversify 93.61% <ø> (ø)
di.nestjs 87.25% <ø> (ø)
doubles.jest 100.00% <ø> (ø)
doubles.sinon 100.00% <ø> (ø)
doubles.vitest 100.00% <ø> (ø)
unit 84.00% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 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.

@omermorad omermorad changed the base branch from master to next November 25, 2025 22:20
@omermorad omermorad changed the title docs: packages readme files docs(di.nestjs,di.inversify,unit): packages readme files Nov 25, 2025
@omermorad omermorad force-pushed the next branch 3 times, most recently from 2ba1f40 to cdf5261 Compare November 25, 2025 22:31
@omermorad omermorad force-pushed the docs/packages-readme-files branch 3 times, most recently from 4975670 to 8e375c3 Compare November 25, 2025 22:35
@omermorad omermorad self-assigned this Nov 25, 2025
@omermorad omermorad force-pushed the docs/packages-readme-files branch from 8e375c3 to f559a4a Compare November 26, 2025 21:48
@omermorad omermorad assigned iddan and unassigned omermorad Dec 4, 2025
@omermorad omermorad added the documentation Improvements or additions to documentation label Dec 4, 2025
@iddan iddan force-pushed the next branch 2 times, most recently from 3120956 to 32bec03 Compare December 7, 2025 19:03
@omermorad omermorad changed the base branch from next to master December 8, 2025 05:30
@iddan iddan force-pushed the docs/packages-readme-files branch from 64461c5 to 069bfb8 Compare December 8, 2025 19:38
@iddan iddan force-pushed the docs/packages-readme-files branch from 069bfb8 to 995b400 Compare December 8, 2025 19:54
@iddan iddan force-pushed the docs/packages-readme-files branch from bfd7422 to 1986681 Compare December 8, 2025 19:59
@iddan iddan changed the title docs(di.nestjs,di.inversify,unit): packages readme files Add Package Readme Files Dec 8, 2025
@omermorad omermorad merged commit 150500d into master Dec 8, 2025
50 checks passed
@omermorad omermorad deleted the docs/packages-readme-files branch December 8, 2025 22:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants