Skip to content

[Chore]: Add badges to README.md #7

Closed as not planned
Closed as not planned

Description

@martyy-code

Task Description

Add GitHub badges to the README.md file to display key metadata at a glance.

Scope Definition

In Scope:

  • Add npm version badge
  • Add npm downloads badge
  • Add license badge
  • Add GitHub Actions CI badge
  • Add TypeScript badge

Out of Scope:

  • Changes to the documentation website
  • Changes to CI/CD workflows

User-Facing Impact

  • No user-facing impact - internal/tooling/maintenance only

Component(s) Affected

  • Documentation

Priority & Effort

Priority: p3: Low - Nice to have, can wait

Estimated Effort: effort: xs - Few minutes

Related Issues & Dependencies

  • Related issue: Setup of this repository

Technical Approach

Files that may need changes:

  • README.md

Suggested badges:

  • npm: https://img.shields.io/npm/v/@deessejs/errors
  • Downloads: https://img.shields.io/npm/dm/@deessejs/errors
  • License: https://img.shields.io/npm/l/@deessejs/errors
  • CI: https://img.shields.io/github/actions/workflow/status/nesalia-inc/errors/ci.yml
  • TypeScript: https://img.shields.io/badge/TypeScript-5.0-blue

Risk & Rollback

Risk: Low - simple documentation change

Rollback plan: Revert README.md changes

Pre-Submission Checklist

  • Task description clearly defines the end state
  • Scope (in/out) is clearly defined
  • Component(s) affected are specified
  • I have searched for existing issues covering this work
  • Dependencies are identified (blocks/blocked-by)
  • I understand this issue will be labeled according to the project taxonomy
  • Note: type: chore is a project-specific label for general maintenance tasks not covered by the standard type labels (bug, feature, refactor, docs, security)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    effort: xsA few minutesp3: lowNice to havestatus: readyValidated by Tech Lead, ready to pick uptype: choreGeneral maintenance tasks

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions