docs(queue): align README to the @bymax-one lib standard - #9
Merged
Conversation
…ges, sections)
There was a problem hiding this comment.
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.mdlayout 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.onein both README andSECURITY.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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Brings the README to the exact same standard as
@bymax-one/nest-auth,nest-logger, andnest-cache:<h1 align=center>, tagline (<strong>+<sub>feature list ending in Zero Runtime Dependencies).support@bymax.onein both README andSECURITY.md(matches all sibling libs).Docs-only; no source or CI changes.