Skip to main content

GitHub Hacktoberfest combined status (suggestion label override)

This badge is designed for projects hosted on GitHub which are participating inHacktoberfest, an initiative to encourage participating in open-source projects. The badge can be added to the project readme to encourage potential contributors to review the suggested issues and to celebrate the contributions that have already been made. The badge displays three pieces of information:

  • The number of suggested issues. By default this will count open issues with the hacktoberfest label, however you can pick a different label (e.g.?suggestion_label=good%20first%20issue).
  • The number of pull requests opened in October. This excludes any PR with the invalid label.
  • The number of days left of October.

If your GitHub badge errors, it might be because you hit GitHub's rate limits. You can increase Shields.io's rate limit byadding the Shields GitHub application using your GitHub account.

Path Parameters
year string — REQUIRED

Possible values: [2019, 2020, 2021, 2022]

Example: 2022
user string — REQUIRED
Example: tmrowco
repo string — REQUIRED
Example: tmrowapp-contrib
Query Parameters
suggestion_label string
Example: help wanted
style string

One of: flat (default), flat-square, plastic, for-the-badge, social

Example: flat
logo string

One of the named logos (bitcoin, dependabot, gitlab, npm, paypal, serverfault, stackexchange, superuser, telegram, travis) or simple-icons. Simple-icons are referenced using icon slugs which can be found on the simple-icons site or in the slugs.md file in the simple-icons repository.

Example: appveyor
logoColor string

The color of the logo (hex, rgb, rgba, hsl, hsla and css named colors supported). Supported for named logos and Shields logos but not for custom logos. For multicolor Shields logos, the corresponding named logo will be used and colored.

Example: violet
label string

Override the default left-hand-side text (URL-Encoding needed for spaces or special characters!)

Example: healthiness
labelColor string

Background color of the left part (hex, rgb, rgba, hsl, hsla and css named colors supported). The legacy name "colorA" is also supported.

Example: abcdef
color string

Background color of the right part (hex, rgb, rgba, hsl, hsla and css named colors supported). The legacy name "colorB" is also supported.

Example: fedcba
cacheSeconds string

HTTP cache lifetime (rules are applied to infer a default value on a per-badge basis, any values specified below the default will be ignored). The legacy name "maxAge" is also supported.

Example: 3600
link string[]

Specify what clicking on the left/right of a badge should do. Note that this only works when integrating your badge in an <object> HTML tag, but not an <img> tag or a markup language.