DOCSEARCHbyAlgolia
Submit Docs

dwyl/repo-badges

repository·main·Indexed 25 days ago

https://github.com/dwyl/repo-badges

A collection of high-quality badges for code repositories to signal project health, security, documentation, and quality standards. Includes guides for integrating badges from Inch-CI, Snyk, Codecov, CodeClimate, Badge Fury, Nodei.co, david-dm.org, GitHub Actions, Travis CI, and Gitter, as well as a GitHub repository hit counter via hits.dwyl.com.

Tokens
1.7K
Snippets
8
Records
16
Agent score
34%

What's inside repo-badges

  1. Overview of Code Repository Badges

    main
    This project provides a collection of badges used in code repositories to signal high standards to fellow developers. These badges act as visual indicators for various project health and quality metrics, including documentation status, security, continuous integration, test coverage, code quality, and dependency status.

  3. Add GitHub repository hit counter badges

    main

    To track and display how many people have viewed your GitHub repository, visit https://hits.dwyl.com to generate a badge.

    Template: [![HitCount](https://hits.dwyl.com/{username}/{project-name}.svg)](https://hits.dwyl.com/{username}/{project-name})

    [![HitCount](https://hits.dwyl.com/dwyl/start-here.svg)](https://hits.dwyl.com/dwyl/start-here)

  5. Add Continuous Integration (Build Status) Badge

    main
    A build status badge (e.g., from Travis CI) indicates whether the project's tests are currently passing. A 'broken' build is a signal that the software may not work as advertised.

  6. Add Gitter chat badges

    main

    Encourage users to join your developer chat by adding a Gitter badge.

    General template: [![Join the chat at https://gitter.im/{ORG-or-USERNAME}/{REPO-NAME}](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/{ORG-or-USERNAME}/{REPO-NAME})

    dwyl organization template: If you are working within the dwyl organization, use this specific snippet:

    [![Join the chat at https://gitter.im/dwyl/chat](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/dwyl/chat?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

  7. Add NPM Module Version Badge via Badge Fury

    main
    To signal the latest version of your NPM module without users needing to check package.json, use Badge Fury. Visit https://badge.fury.io/for/js and enter your npm package name to get the badge.

  8. Add Travis-CI build status badges

    main

    To include a Travis-CI build status badge, ensure your project is set up on Travis-CI with unit tests. Use the following Markdown template, replacing the placeholders with your organization/username and repository name.

    [![Build Status](https://travis-ci.org/{ORG-or-USERNAME}/{REPO-NAME}.png?branch=master)](https://travis-ci.org/{ORG-or-USERNAME}/{REPO-NAME})

  9. Setup CodeCov for test coverage badges

    main

    To track and display test coverage using CodeCov, follow these steps:

    1. Configure .travis.yml: Add the codecov installation and execution steps to your Travis configuration.
    2. Generate Coverage Report: Ensure your test script (e.g., in package.json) outputs a coverage report using a tool like istanbul.

    Example .travis.yml configuration:

    before_install:
  - pip install --user codecov
after_success:
  - codecov --file coverage/lcov.info --disable search

    Example package.json test script:

    "scripts": {
  "test": "./node_modules/.bin/istanbul cover ./node_modules/tape/bin/tape ./test/*.js"
}

  10. Add NPM download statistics badges

    main

    To show NPM download statistics, use nodei.co.

    To make the badge clickable (linking to your NPM package), use this template, replacing YOUR-MODULE-NAME with your package name:

    [![https://nodei.co/npm/YOUR-MODULE-NAME.png?downloads=true&downloadRank=true&stars=true](https://nodei.co/npm/YOUR-MODULE-NAME.png?downloads=true&downloadRank=true&stars=true)](https://www.npmjs.com/package/YOUR-MODULE-NAME)

  11. Add GitHub Actions/Workflows status badges

    main

    You can display the status of your GitHub Actions workflows in your README.md.

    Regular template: Use the following pattern to point to your specific workflow file: ![example workflow](https://github.com/<OWNER>/<REPOSITORY>/actions/workflows/<WORKFLOW_FILE>/badge.svg)

    Custom badge via Shields.io: You can also use Shields.io to create custom styled badges for your workflows.

    ![GitHub CI](https://github.com/dwyl/auth_plug/actions/workflows/ci.yml/badge.svg)

![GitHub Workflow Status](https://img.shields.io/github/workflow/status/dwyl/auth_plug/Elixir%20CI?label=build&style=flat-square)