What to do in this issue can you explain

Personally I would use Codecov, but I asked ChatGPT and found simpler way:

To add Jest test coverage information to a GitHub README.md file, follow these steps:

1. Enable Jest Coverage Reporting

• Update your Jest configuration (jest.config.js, jest.config.ts, or package.json):

  module.exports = {
    collectCoverage: true,
    coverageDirectory: 'coverage',
    coverageReporters: ['json', 'lcov', 'text', 'clover'], // Customize as needed
  };

  This will generate coverage data when you run your tests.

2. Run Tests with Coverage

• Run the following command:

  npx jest --coverage

• This generates a coverage folder in your project with coverage reports in various formats, such as lcov and text-summary.

3. Generate a Coverage Badge

Use a tool like [Shields.io](https://shields.io/) or an npm package like jest-coverage-badger to create a badge.

Option A: Shields.io (Manual)

1. Extract the coverage percentage from the text-summary output or coverage/lcov-report/index.html.
2. Generate a badge using this URL format:

   https://img.shields.io/badge/coverage-80%25-brightgreen
   

   Replace 80% with your coverage percentage and adjust the color based on your desired thresholds.

Option B: Automate with jest-coverage-badger

1. Install the package:

   npm install --save-dev jest-coverage-badger

2. Add it to your package.json scripts:

   "scripts": {
     "test:coverage": "jest --coverage",
     "coverage:badge": "jest-coverage-badger -o ./"
   }

3. Run the following command to generate a badge:

   npm run coverage:badge

   This generates a coverage-badge.svg file.

4. Update Your README

• Add the badge to your README.md:

  ![Coverage](./coverage-badge.svg)

• If using Shields.io:

  ![Coverage](https://img.shields.io/badge/coverage-80%25-brightgreen)

5. Automate Coverage Updates (Optional)

• Use a GitHub Action to automatically update the coverage badge:
  1. Create a workflow file .github/workflows/test-coverage.yml:

     name: Test Coverage
     
     on:
       push:
         branches:
           - main
     
     jobs:
       coverage:
         runs-on: ubuntu-latest
         steps:
           - name: Checkout code
             uses: actions/checkout@v3
     
           - name: Set up Node.js
             uses: actions/setup-node@v3
             with:
               node-version: 16
     
           - name: Install dependencies
             run: npm install
     
           - name: Run tests with coverage
             run: npm run test:coverage
     
           - name: Generate coverage badge
             run: npm run coverage:badge
     
           - name: Commit and push changes
             run: |
               git config --global user.name "github-actions"
               git config --global user.email "[email protected]"
               git add .
               git commit -m "Update coverage badge"
               git push
             env:
               GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

  2. Push this file to your repository. The action will update the badge automatically on new commits.

You're now set up with test coverage reporting in your GitHub README.md!

@ImBIOS it is showing 0% courage

@ImBIOS it is showing 0% courage

I think you're correct, the current coverage might near to 0%.

We need more test contribution or even migration to typescript to help new contributor adapt faster.

@ImBIOS it is showing 0% courage

I think you're correct, the current coverage might near to 0%.

We need more test contribution or even migration to typescript to help new contributor adapt faster.

yes

I've prepared the GitHub Action we can use to generate the code coverage badge:

• https://github.com/ImBIOS/lcov-coverage-badge