Sobre arquivos FUNDING
Para configurar o botão de patrocinador, edite um arquivo FUNDING.yml na pasta .github
do repositório, no branch padrão. É possível configurar o botão para incluir desenvolvedores patrocinados no GitHub Sponsors, em plataformas de financiamento externas ou em uma URL de financiamento personalizado. Para obter mais informações a respeito do GitHub Sponsors, consulte "Sobre o GitHub Sponsors".
Você pode adicionar um nome de usuário, de pacote ou de projeto por plataforma de financiamento externa e até quatro URLs personalizadas. Você pode adicionar até quatro organizações ou desenvolvedores patrocinados no GitHub Sponsors. Adicione cada plataforma em uma nova linha, usando a seguinte sintaxe:
Plataforma | Sintaxe |
---|---|
Mentoria LFX (antiga CommunityBridge) | community_bridge: PROJECT-NAME |
GitHub Sponsors | github: USERNAME or github: [USERNAME, USERNAME, USERNAME, USERNAME] |
IssueHunt | issuehunt: USERNAME |
Ko-fi | ko_fi: USERNAME |
Liberapay | liberapay: USERNAME |
Open Collective | open_collective: USERNAME |
Otechie | otechie: USERNAME |
Patreon | patreon: USERNAME |
Tidelift | tidelift: PLATFORM-NAME/PACKAGE-NAME |
URL personalizado | custom: LINK1 ou custom: [LINK1, LINK2, LINK3, LINK4] |
Em Tidelift, use a sintaxe platform-name/package-name
com os seguintes nomes de plataforma:
Linguagem | Nome da plataforma |
---|---|
JavaScript | npm |
Python | pypi |
Ruby | rubygems |
Java | maven |
PHP | packagist |
C# | nuget |
Veja um exemplo de arquivo FUNDING.yml:
github: [octocat, surftocat]
patreon: octocat
tidelift: npm/octo-package
custom: ["https://www.paypal.me/octocat", octocat.com]
Observação: se um URL personalizado em um array incluir :
, você deverá colocar o URL entre aspas. Por exemplo, "https://www.paypal.me/octocat"
.
Você pode criar um botão de patrocinador padrão para sua organização ou conta de usuário. Para obter mais informações, consulte "Criando um arquivo padrão de integridade da comunidade."
Os links de financiamento permitem que projetos de código aberto recebam apoio financeiro direto da comunidade. Não apoiamos o uso de links de financiamento para outros fins (como publicidade) ou grupos de apoio político, de caridade ou comunitários. Se você estiver em dúvida se há suporte para o seu uso pretendido, entre em contato com Suporte do GitHub ou Suporte do GitHub Premium.
Exibir botão de patrocinador no repositório
Qualquer pessoa com permissões de administrador pode habilitar um botão de patrocinador em um repositório.
- No GitHub, navegue até a página principal do repositório.
- No nome do seu repositório, clique em Configurações.
- Em Features (Recursos), desmarque Sponsorships (Patrocínios).
- Em "Patrocínios", clique em Configurar botão de patrocinador ou Substituir links de financiamento.
- No editor de arquivos, siga as instruções descritas no arquivo FUNDING.yml para adicionar links aos locais de financiamento.
- No final da página, digite uma mensagem de commit curta e significativa que descreva a alteração feita no arquivo. Você pode atribuir o commit a mais de um autor na mensagem de commit. Para obter mais informações, consulte "Criar um commit com vários co-autores."
- Abaixo dos campos de mensagem do commit, opte por adicionar o commit ao branch atual ou a um novo branch. Se seu branch atual for o branch-padrão, você deverá optar por criar um novo branch para seu commit e, em seguida, criar um pull request. Para obter mais informações, consulte "Criar uma nova pull request."
- Clique em Propose new file.