Skip to main content

Exibir botão de patrocinador no repositório

Você pode adicionar um botão do patrocinador no repositório para aumentar a visibilidade das opções de financiamento do seu projeto de código aberto.

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 obter mais informações sobre o 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 seguinte sintaxe:

PlataformaSintaxe
LFX Mentorship (antigo CommunityBridge)community_bridge: PROJECT-NAME
GitHub Sponsorsgithub: USERNAME ou github: [USERNAME, USERNAME, USERNAME, USERNAME]
IssueHuntissuehunt: USERNAME
Ko-fiko_fi: USERNAME
Liberapayliberapay: USERNAME
Open Collectiveopen_collective: USERNAME
Otechieotechie: USERNAME
Patreonpatreon: USERNAME
Tidelifttidelift: PLATFORM-NAME/PACKAGE-NAME
URL personalizadacustom: LINK1 ou custom: [LINK1, LINK2, LINK3, LINK4]

Para o Tidelift, use a sintaxe platform-name/package-name com os seguintes nomes de plataformas:

IdiomaNome da plataforma
JavaScriptnpm
Pythonpypi
Rubyrubygems
Javamaven
PHPpackagist
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 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 obter mais informações, confira "Como criar 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.

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.

  1. On GitHub.com, navigate to the main page of the repository. 1. Abaixo do nome do repositório, clique em Configurações. Botão Configurações do repositório
  2. Em Recursos, selecione Patrocínios. Caixa de seleção usada para habilitar os patrocínios
  3. Em "Patrocínios", clique no botão Configurar patrocinador ou Substituir links de financiamento. Botão usado para configurar o botão de patrocinador
  4. No editor de arquivos, siga as instruções descritas no arquivo FUNDING.yml para adicionar links aos locais de financiamento. Editar o arquivo FUNDING para adicionar links aos locais de financiamento 1. 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, confira "Como criar um commit com vários coautores". Mensagem de commit para a alteração 1. 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". Opções de commit no branch 1. Clique em Propor novo arquivo. Botão Propor novo arquivo

Leitura adicional