GitHub Hacktoberfest combined status
This badge is designed for projects hosted on GitHub which are participating in Hacktoberfest, 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 by adding the Shields GitHub application using your GitHub account.
Path Parameters |
---|
year string — REQUIREDPossible values: [ Example:
|
user string — REQUIREDExample:
|
repo string — REQUIREDExample:
|
Query Parameters |
---|
suggestion_label stringExample:
|
style stringPossible values: [ If not specified, the default style for this badge is "flat". Example:
|
logo stringOne of the named logos (bitcoin, dependabot, gitlab, npm, paypal, serverfault, stackexchange, superuser, telegram, travis) or simple-icons. All simple-icons are referenced using icon slugs. You can click the icon title on simple-icons to copy the slug or they can be found in the slugs.md file in the simple-icons repository. Further info. Example:
|
logoColor stringThe 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:
|
label stringOverride the default left-hand-side text (URL-Encoding needed for spaces or special characters!) Example:
|
labelColor stringBackground color of the left part (hex, rgb, rgba, hsl, hsla and css named colors supported). Example:
|
color stringBackground color of the right part (hex, rgb, rgba, hsl, hsla and css named colors supported). Example:
|
cacheSeconds stringHTTP cache lifetime (rules are applied to infer a default value on a per-badge basis, any values specified below the default will be ignored). Example:
|
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 |