https://shields.io/assets/js/16faffd5.2f26080f.js

1"use strict";(self.webpackChunkshields_io=self.webpackChunkshields_io||[]).push([[9824],{49560(e,t,s){s.r(t),s.d(t,{contentTitle:()=>l,default:()=>c,frontMatter:()=>o,metadata:()=>i,toc:()=>a});const i=JSON.parse('{"type":"api","id":"git-hub-hacktoberfest-combined-status","title":"GitHub Hacktoberfest combined status","description":"","slug":"/git-hub-hacktoberfest-combined-status","frontMatter":{},"api":{"description":"\\nThis badge is designed for projects hosted on GitHub which are\\nparticipating in\\n[Hacktoberfest](https://hacktoberfest.digitalocean.com),\\nan initiative to encourage participating in open-source projects. The\\nbadge can be added to the project readme to encourage potential\\ncontributors to review the suggested issues and to celebrate the\\ncontributions that have already been made.\\nThe badge displays three pieces of information:\\n\\n- The number of suggested issues. By default this will count open\\n  issues with the <strong>hacktoberfest</strong> label, however you\\n  can pick a different label (e.g.\\n  `?suggestion_label=good%20first%20issue`).\\n- The number of pull requests opened in October. This excludes any\\n  PR with the <strong>invalid</strong> label.\\n- The number of days left of October.\\n\\n\\nYou can help increase Shields.io\'s rate limit by\\n[authorizing the Shields.io GitHub application](https://img.shields.io/github-auth).\\nRead more about [how it works](/blog/token-pool).\\n\\n","parameters":[{"name":"year","in":"path","required":true,"schema":{"type":"string","enum":["2019","2020","2021","2022","2023","2024","2025","2026"]},"example":"2025"},{"name":"user","in":"path","required":true,"schema":{"type":"string"},"example":"tmrowco"},{"name":"repo","in":"path","required":true,"schema":{"type":"string"},"example":"tmrowapp-contrib"},{"name":"suggestion_label","in":"query","required":false,"schema":{"type":"string"},"example":"help wanted"},{"name":"style","in":"query","required":false,"description":"If not specified, the default style for this badge is \\"flat\\".","schema":{"type":"string","enum":["flat","flat-square","plastic","for-the-badge","social"]},"example":"flat"},{"name":"logo","in":"query","required":false,"description":"Icon slug from simple-icons. You can click the icon title on <a href=\\"https://simpleicons.org/\\" rel=\\"noopener noreferrer\\" target=\\"_blank\\">simple-icons</a> to copy the slug or they can be found in the <a href=\\"https://github.com/simple-icons/simple-icons/blob/master/slugs.md\\">slugs.md file</a> in the simple-icons repository. <a href=\\"/docs/logos\\">Further info</a>.","schema":{"type":"string"},"example":"appveyor"},{"name":"logoColor","in":"query","required":false,"description":"The color of the logo (hex, rgb, rgba, hsl, hsla and css named colors supported). Supported for simple-icons logos but not for custom logos.","schema":{"type":"string"},"example":"violet"},{"name":"logoSize","in":"query","required":false,"description":"Make icons adaptively resize by setting `auto`. Useful for some wider logos like `amd` and `amg`. Supported for simple-icons logos but not for custom logos.","schema":{"type":"string"},"example":"auto"},{"name":"label","in":"query","required":false,"description":"Override the default left-hand-side text (<a href=\\"https://developer.mozilla.org/en-US/docs/Glossary/percent-encoding\\">URL-Encoding</a> needed for spaces or special characters!)","schema":{"type":"string"},"example":"healthiness"},{"name":"labelColor","in":"query","required":false,"description":"Background color of the left part (hex, rgb, rgba, hsl, hsla and css named colors supported).","schema":{"type":"string"},"example":"abcdef"},{"name":"color","in":"query","required":false,"description":"Background color of the right part (hex, rgb, rgba, hsl, hsla and css named colors supported).","schema":{"type":"string"},"example":"fedcba"},{"name":"cacheSeconds","in":"query","required":false,"description":"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).","schema":{"type":"string"},"example":"3600"},{"name":"link","in":"query","required":false,"description":"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.","style":"form","explode":true,"schema":{"type":"array","maxItems":2,"items":{"type":"string"}}}],"x-code-samples":[{"lang":"URL","label":"URL","source":"$url"},{"lang":"Markdown","label":"Markdown","source":"![GitHub Hacktoberfest combined status]($url)"},{"lang":"reStructuredText","label":"rSt","source":".. image:: $url\\n   :alt: GitHub Hacktoberfest combined status"},{"lang":"AsciiDoc","label":"AsciiDoc","source":"image:$url[GitHub Hacktoberfest combined status]"},{"lang":"HTML","label":"HTML","source":"<img alt=\\"GitHub Hacktoberfest combined status\\" src=\\"$url\\">"}],"method":"get","path":"/github/hacktoberfest/{year}/{user}/{repo}","info":{"version":"1.0.0","title":"Issue Tracking","license":{"name":"CC0"}}

1,"postman":{"name":"GitHub Hacktoberfest combined status","description":{"content":"\\nThis badge is designed for projects hosted on GitHub which are\\nparticipating in\\n[Hacktoberfest](https://hacktoberfest.digitalocean.com),\\nan initiative to encourage participating in open-source projects. The\\nbadge can be added to the project readme to encourage potential\\ncontributors to review the suggested issues and to celebrate the\\ncontributions that have already been made.\\nThe badge displays three pieces of information:\\n\\n- The number of suggested issues. By default this will count open\\n  issues with the <strong>hacktoberfest</strong> label, however you\\n  can pick a different label (e.g.\\n  `?suggestion_label=good%20first%20issue`).\\n- The number of pull requests opened in October. This excludes any\\n  PR with the <strong>invalid</strong> label.\\n- The number of days left of October.\\n\\n\\nYou can help increase Shields.io\'s rate limit by\\n[authorizing the Shields.io GitHub application](https://img.shields.io/github-auth).\\nRead more about [how it works](/blog/token-pool).\\n\\n","type":"text/plain"},"url":{"path":["github","hacktoberfest",":year",":user",":repo"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"suggestion_label","value":"<string>"},{"disabled":false,"description":{"content":"If not specified, the default style for this badge is \\"flat\\".","type":"text/plain"},"key":"style","value":"<string>"},{"disabled":false,"description":{"content":"Icon slug from simple-icons. You can click the icon title on <a href=\\"https://simpleicons.org/\\" rel=\\"noopener noreferrer\\" target=\\"_blank\\">simple-icons</a> to copy the slug or they can be found in the <a href=\\"https://github.com/simple-icons/simple-icons/blob/master/slugs.md\\">slugs.md file</a> in the simple-icons repository. <a href=\\"/docs/logos\\">Further info</a>.","type":"text/plain"},"key":"logo","value":"<string>"},{"disabled":false,"description":{"content":"The color of the logo (hex, rgb, rgba, hsl, hsla and css named colors supported). Supported for simple-icons logos but not for custom logos.","type":"text/plain"},"key":"logoColor","value":"<string>"},{"disabled":false,"description":{"content":"Make icons adaptively resize by setting `auto`. Useful for some wider logos like `amd` and `amg`. Supported for simple-icons logos but not for custom logos.","type":"text/plain"},"key":"logoSize","value":"<string>"},{"disabled":false,"description":{"content":"Override the default left-hand-side text (<a href=\\"https://developer.mozilla.org/en-US/docs/Glossary/percent-encoding\\">URL-Encoding</a> needed for spaces or special characters!)","type":"text/plain"},"key":"label","value":"<string>"},{"disabled":false,"description":{"content":"Background color of the left part (hex, rgb, rgba, hsl, hsla and css named colors supported).","type":"text/plain"},"key":"labelColor","value":"<string>"},{"disabled":false,"description":{"content":"Background color of the right part (hex, rgb, rgba, hsl, hsla and css named colors supported).","type":"text/plain"},"key":"color","value":"<string>"},{"disabled":false,"description":{"content":"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).","type":"text/plain"},"key":"cacheSeconds","value":"<string>"},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"link","value":"<string>"},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"link","value":"<string>"}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"<string>","key":"year"},{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"<string>","key":"user"},{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"<string>","key":"repo"}]},"method":"GET"}},"source":"@site/categories/issue-tracking.yaml","sourceDirName":".","permalink":"/badges/git-hub-hacktoberfest-combined-status","previous":{"title":"GitHub commit merge status","permalink":"/badges/git-hub-commit-merge-status"},"next":{"title":"GitHub issue custom search","permalink":"/badges/git-hub-issue-custom-search"}}');var n=s(74848),r=s(28453);const o={},l="GitHub Hacktoberfest combined status",a=[];function d(e){const t={a:"a",code:"code",h1:"h1",header:"header",li:"li",p:"p",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.header,{children:(0,n.jsx)(t.h1,{id:"github-hacktoberfest-combined-status",children:"GitHub Hacktoberfest combined status"})}),"\n",(0,n.jsxs)(t.p,{children:["This badge is designed for projects hosted on GitHub which are\nparticipating in\n",(0,n.jsx)(t.a,{href:"https://hacktoberfest.digitalocean.com",children:"Hacktoberfest"}),",\nan initiative to encourage participating in open-source projects. The\nbadge can be added to the project readme to encourage potential\ncontributors to review the suggested issues and to celebrate the\ncontributions that have already been made.\nThe badge displays three pieces of information:"]}),"\n",(0,n.jsxs)(t.ul,{children:["\n",(0,n.jsxs)(t.li,{children:["The number of suggested issues. By default this will count open\nissues with the ",(0,n.jsx)("strong",{children:"hacktoberfest"})," label, however you\ncan pick a different label (e.g.\n",(0,n.jsx)(t.code,{children:"?suggestion_label=good%20first%20issue"}),")."]}),"\n",(0,n.jsxs)(t.li,{children:["The number of pull requests opened in October. This excludes any\nPR with the ",(0,n.jsx)("strong",{children:"invalid"})," label."]}),"\n",(0,n.jsx)(t.li,{children:"The number of days left of October."}),"\n"]}),"\n",(0,n.jsxs)(t.p,{children:["You can help increase Shields.io's rate limit by\n",(0,n.jsx)(t.a,{href:"https://img.shields.io/github-auth",children:"authorizing the Shields.io GitHub application"}),".\nRead more about ",(0,n.jsx)(t.a,{href:"/blog/token-pool",children:"how it works"}),"."]}),"\n",(0,n.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"year"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsxs)(t.p,{children:[(0,n.jsx)(t.strong,{children:"Possible values:"})," [",(0,n.jsx)(t.code,{children:"2019"}),", ",(0,n.jsx)(t.code,{children:"2020"}),", ",(0,n.jsx)(t.code,{children:"2021"}),", ",(0,n.jsx)(t.code,{children:"2022"}),", ",(0,n.jsx)(t.code,{children:"2023"}),", ",(0,n.jsx)(t.code,{children:"2024"}),", ",(0,n.jsx)(t.code,{children:"2025"}),", ",(0,n.jsx)(t.code,{children:"2026"}),"]"]})}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsxs)(t.p,{children:["Example:\n",(0,n.jsx)("code",{children:"2025"})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"user"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsxs)(t.p,{children:["Example:\n",(0,n.jsx)("code",{children:"tmrowco"})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"repo"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsxs)(t.p,{children:["Example:\n",(0,n.jsx)("code",{children:"tmrowapp-contrib"})]})})]})})]})]}),"\n",(0,n.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsx)("th",{style:{textAlign:"left"},children:"Query Parameters"})})}),(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"suggestion_label"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsxs)(t.p,{children:["Example:\n",(0,n.jsx)("code",{children:"help wanted"})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"style"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsxs)(t.p,{children:[(0,n.jsx)(t.strong,{children:"Possible values:"})," [",(0,n.jsx)(t.code,{children:"flat"}),", ",(0,n.jsx)(t.code,{children:"flat-square"}),", ",(0,n.jsx)(t.code,{children:"plastic"}),", ",(0,n.jsx)(t.code,{children:"for-the-badge"}),", ",(0,n.jsx)(t.code,{children:"social"}),"]"]})}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(t.p,{children:'If not specified, the default style for this badge is "flat".'})}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsxs)(t.p,{children:["Example:\n",(0,n.jsx)("code",{children:"flat"})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"logo"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsxs)(t.p,{children:["Icon slug from simple-icons. You can click the icon title on ",(0,n.jsx)("a",{href:"https://simpleicons.org/",rel:"noopener noreferrer",target:"_blank",children:"simple-icons"})," to copy the slug or they can be found in the ",(0,n.jsx)("a",{href:"https://github.com/simple-icons/simple-icons/blob/master/slugs.md",children:"slugs.md file"})," in the simple-icons repository. ",(0,n.jsx)("a",{href:"/docs/logos",children:"Further info"}),"."]})}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsxs)(t.p,{children:["Example:\n",(0,n.jsx)("code",{children:"appveyor"})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"logoColor"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(t.p,{children:"The color of the logo (hex, rgb, rgba, hsl, hsla and css named colors supported). Supported for simple-icons logos but not for custom logos."})}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsxs)(t.p,{children:["Example:\n",(0,n.jsx)("code",{children:"violet"})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"logoSize"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsxs)(t.p,{children:["Make icons adaptively resize by setting ",(0,n.jsx)(t.code,{children:"auto"}),". Useful for some wider logos like ",(0,n.jsx)(t.code,{children:"amd"})," and ",(0,n.jsx)(t.code,{children:"amg"}),". Supported for simple-icons logos but not for custom logos."]})}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsxs)(t.p,{children:["Example:\n",(0,n.jsx)("code",{children:"auto"})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"label"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsxs)(t.p,{children:["Override the default left-hand-side text (",(0,n.jsx)("a",{href:"https://developer.mozilla.org/en-US/docs/Glossary/percent-encoding",children:"URL-Encoding"})," needed for spaces or special characters!)"]})}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsxs)(t.p,{children:["Example:\n",(0,n.jsx)("code",{children:"healthiness"})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"labelColor"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"}

1,children:(0,n.jsx)(t.p,{children:"Background color of the left part (hex, rgb, rgba, hsl, hsla and css named colors supported)."})}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsxs)(t.p,{children:["Example:\n",(0,n.jsx)("code",{children:"abcdef"})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"color"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(t.p,{children:"Background color of the right part (hex, rgb, rgba, hsl, hsla and css named colors supported)."})}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsxs)(t.p,{children:["Example:\n",(0,n.jsx)("code",{children:"fedcba"})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"cacheSeconds"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)(t.p,{children:"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)."})}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsxs)(t.p,{children:["Example:\n",(0,n.jsx)("code",{children:"3600"})]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"link"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string[]"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsxs)(t.p,{children:["Specify what clicking on the left/right of a badge should do. Note that this only works when integrating your badge in an ",(0,n.jsx)(t.code,{children:"<object>"})," HTML tag, but not an ",(0,n.jsx)(t.code,{children:"<img>"})," tag or a markup language."]})})]})})]})]})]})}function c(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(d,{...e})}):d(e)}},28453(e,t,s){s.d(t,{R:()=>o,x:()=>l});var i=s(96540);const n={},r=i.createContext(n);function o(e){const t=i.useContext(r);return i.useMemo(function(){return"function"==typeof e?e(t):{...t,...e}},[t,e])}function l(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:o(e.components),i.createElement(r.Provider,{value:t},e.children)}}}]);