Skip to content

Add project badges to README #23

Description

@KHolodilin

Description

Add professional project badges to README.md to display project status, version, test coverage, CI status, and other important metrics. This will improve project visibility and provide quick access to key project information.

Tasks

  • Add badges to the beginning of README.md
    • PyPI version badge: [![PyPI](https://img.shields.io/pypi/v/email-processor)](https://pypi.org/project/email-processor/)
    • CI status badge: [![CI](https://github.com/KHolodilin/python-email-automation-processor/actions/workflows/ci.yml/badge.svg)](https://github.com/KHolodilin/python-email-automation-processor/actions/workflows/ci.yml)
    • Test Coverage badge: [![Test Coverage](https://codecov.io/gh/KHolodilin/python-email-automation-processor/branch/main/graph/badge.svg)](https://codecov.io/gh/KHolodilin/python-email-automation-processor)
    • Python version badge: [![Python Version](https://img.shields.io/badge/python-3.9%2B-blue.svg)](https://www.python.org/downloads/)
    • License badge: [![License](https://img.shields.io/github/license/KHolodilin/python-email-automation-processor)](LICENSE)
    • Stars badge: [![Stars](https://img.shields.io/github/stars/KHolodilin/python-email-automation-processor)](https://github.com/KHolodilin/python-email-automation-processor/stargazers)
    • Code style badge (Ruff): [![Code style: Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
  • Verify link correctness
    • Ensure all links point to correct repositories
    • Verify badges display correctly
    • Verify badges work after merge to main
  • Formatting
    • Place badges in logical order
    • Add empty line after badges for readability
    • Ensure badges don't break README structure

Acceptance Criteria

  • All tests pass
  • Pre-commit checks pass
  • Test coverage meets requirements (if applicable)
  • Code committed
  • Branch pushed to remote repository
  • Pull Request created with main branch

Pull Request

✅ Pull Request created: #24

  • Branch: feature/issue-4-add-readme-badges
  • Status: Ready for review

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions