Skip to content

docs(queue): align README to the @bymax-one lib standard - #9

Merged
msalvatti merged 1 commit into
mainfrom
docs/readme-standardize
Jun 27, 2026
Merged

docs(queue): align README to the @bymax-one lib standard#9
msalvatti merged 1 commit into
mainfrom
docs/readme-standardize

Conversation

@msalvatti

Copy link
Copy Markdown
Member

Brings the README to the exact same standard as @bymax-one/nest-auth, nest-logger, and nest-cache:

  • Centered header — NestJS badge image, <h1 align=center>, tagline (<strong> + <sub> feature list ending in Zero Runtime Dependencies).
  • Same 9 badge tags — npm version, npm downloads, CI status, coverage 100%, mutation 98.99% (→ mutation results), OpenSSF Scorecard (scorecard.dev), license, TypeScript strict, Node.js 24+. (Replaces the old codecov / SLSA / securityscorecards.dev badges.)
  • Nav row — GitHub · Issues · Quick Start · API Reference · Example App.
  • Emoji section headings matching the sibling convention (✨ Overview, 🔥 Features, 🚀 Quick Start, 📖 API Reference, 📦 Subpath Exports, 🤔 Why over, 🧱 Tech Stack, 🧪 Testing & Quality, 🚫 What This Library Does NOT Do, 🤝 Contributing, 🔒 Security Policy, 📄 License) + centered "Built with ❤️ by Bymax One" footer.
  • Added Overview / Why, Features, Tech Stack, Testing & Quality, and Security Policy sections; all existing queue-specific content (Modes, API, decorators, Job Schedulers, dedup/telemetry, graceful shutdown, troubleshooting) is preserved.
  • Aligned the security contact to support@bymax.one in both README and SECURITY.md (matches all sibling libs).

Docs-only; no source or CI changes.

Copilot AI review requested due to automatic review settings June 27, 2026 10:41

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Aligns the repository’s documentation to the shared @bymax-one library README standard, while keeping queue-specific usage details intact and updating the security contact address.

Changes:

  • Reworked README.md layout to the standardized centered header + badge set + nav row, and added/normalized the standard section structure (Overview/Why, Features, Tech Stack, Testing & Quality, Security Policy, etc.).
  • Updated security reporting contact email to support@bymax.one in both README and SECURITY.md.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
README.md Standardizes README structure/badges/navigation and adds common sections while preserving existing queue-specific docs.
SECURITY.md Updates the vulnerability reporting email contact to support@bymax.one.
Comments suppressed due to low confidence (2)

README.md:564

  • "phased roadmap" is a forward-looking framing that can become outdated in the README. If this link is meant as stable contributor guidance, consider describing it in timeless terms (principles/standards) rather than a roadmap.
Pull requests are welcome. Please open an issue first for significant changes.

- Read [`docs/technical_specification.md`](docs/technical_specification.md) for architecture decisions.
- Read [`docs/development_plan.md`](docs/development_plan.md) for the phased roadmap.
- Run the full gate: `pnpm typecheck && pnpm lint && pnpm test:cov:all && pnpm build && pnpm size`

README.md:545

  • This bullet is time-bound ("v6 promotion is planned once…") and is likely to go stale; most of the README is written as timeless guarantees. Consider rephrasing to a present-tense statement about current support and pointing readers to the version policy without promising when v6 will land.
## 🚫 What This Library Does NOT Do

- **NestJS only** — does not work with plain Express, standalone Fastify, or other frameworks.
- **Node.js only** — Deno and Bun are not supported.
- **BullMQ `^5.16` (0.1.x floor)** — v6 promotion is planned once the E2E suite is

@msalvatti
msalvatti merged commit 4f5d143 into main Jun 27, 2026
7 checks passed
@msalvatti
msalvatti deleted the docs/readme-standardize branch June 27, 2026 10:46
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.

2 participants