Publicamos atualizações frequentes em nossa documentação, e a tradução desta página ainda pode estar em andamento. Para obter as informações mais recentes, acesse a documentação em inglês. Se houver problemas com a tradução desta página, entre em contato conosco.

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.

Neste artigo

Esse documento ajudou você?

Ajude-nos a tornar esses documentos ótimos!

Todos os documentos do GitHub são de código aberto. Você percebeu que algo que está errado ou não está claro? Envie um pull request.

Faça uma contribuição

Ou, aprenda como contribuir.

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:

PlataformaSintaxe
CommunityBridgecommunity_bridge: PROJECT-NAME
GitHub Sponsorsgithub: USERNAME or 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 personalizadocustom: LINK1 ou custom: [LINK1, LINK2, LINK3, LINK4]

Em Tidelift, use a sintaxe platform-name/package-name com os seguintes nomes de plataforma:

LinguagemNome 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 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 no 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.

  1. No GitHub, navegue até a página principal do repositório.
  2. No nome do seu repositório, clique em Configurações.
    Botão de configurações do repositório
  3. Em Features (Recursos), desmarque Sponsorships (Patrocínios).
    Caixa de seleção para habilitar patrocínios
  4. Em "Patrocínios", clique em Configurar botão de patrocinador ou Substituir links de financiamento.
    Botão para configurar o botão de patrocinador
  5. 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
  6. 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."
    Mensagem do commit para sua alteração
  7. 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."
    Opções para fazer commit no branch
  8. Clique em Propose new file.
    Propor botão de novo arquivo

Leia mais

Esse documento ajudou você?

Ajude-nos a tornar esses documentos ótimos!

Todos os documentos do GitHub são de código aberto. Você percebeu que algo que está errado ou não está claro? Envie um pull request.

Faça uma contribuição

Ou, aprenda como contribuir.