Sobre arquivos FUNDING
Configure o botão de patrocinador editando 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 saber mais sobre GitHub Sponsors, confira 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 uma organização e até quatro desenvolvedores patrocinados no GitHub Sponsors. Adicione cada plataforma em uma nova linha usando a sintaxe a seguir.
| Plataforma | Sintaxe |
|---|---|
| LFX Mentorship (antigo CommunityBridge) | community_bridge: PROJECT-NAME |
| GitHub Sponsors | github: USERNAME ou github: [USERNAME, USERNAME, USERNAME, USERNAME] |
| IssueHunt | issuehunt: USERNAME |
| Ko-fi | ko_fi: USERNAME |
| Liberapay | liberapay: USERNAME |
| Open Collective | open_collective: USERNAME |
| Patreon | patreon: USERNAME |
| Tidelift | tidelift: PLATFORM-NAME/PACKAGE-NAME |
| Polar | polar: USERNAME |
| Compre-me um café | buy_me_a_coffee: USERNAME |
| thanks.dev | thanks_dev: u/gh/USERNAME |
| URL personalizada | custom: LINK1 ou custom: [LINK1, LINK2, LINK3, LINK4] |
Para o Tidelift, use a sintaxe platform-name/package-name com os nomes de plataformas a seguir.
| Idioma | Nome da plataforma |
|---|---|
| JavaScript | npm |
| Python | pypi |
| Ruby | rubygems |
| Java | maven |
| PHP | packagist |
| C# | nuget |
Veja um arquivo FUNDING.yml de exemplo:
github: [octocat, surftocat]
patreon: octocat
tidelift: npm/octo-package
custom: ["https://www.paypal.me/octocat", octocat.com]
Note
Se uma URL personalizada em uma matriz incluir :, você precisará colocar a 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 pessoal. Para saber mais, confira Como criar um arquivo padrão de integridade da comunidade.
Note
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 tiver dúvidas sobre se o uso pretendido é compatível, visite a Suporte do GitHub.
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.
-
Em GitHub, acesse a página principal do repositório.
-
Abaixo do nome do repositório, clique em Configurações. Caso não consiga ver a guia "Configurações", selecione o menu suspenso , clique em Configurações.
-
Na página de configurações "Geral", na seção "Recursos", selecione Patrocínios.
-
Na caixa "Patrocínios", clique no botão Configurar patrocinador ou Substituir links de financiamento.
-
No editor de arquivos, siga as instruções descritas no arquivo
FUNDING.ymlpara adicionar links aos locais de financiamento. -
Clique em Fazer commit das alterações...
-
No campo "Mensagem do commit", digite uma mensagem curta e relevante que descreva a alteração que você fez no arquivo. Você pode atribuir o commit a mais de um autor na mensagem de commit. Para obter mais informações, confira "Criar um commit com vários 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, confira "Como criar uma solicitação de pull".
-
Clique em Fazer commit de alterações ou em Propor alterações.
