Skip to main content

Exibir botão de patrocinador no repositório

Configure o botão de patrocinador editando um arquivo FUNDING.yml na pasta . do repositório, no branch padrão. É possível configurar o botão para incluir desenvolvedores patrocinados no Sponsors, em plataformas de financiamento externas ou em uma URL de financiamento personalizado. Para saber mais sobre Sponsors, confira Sobre o 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 Sponsors. Adicione cada plataforma em uma nova linha usando a sintaxe a seguir.

PlataformaSintaxe
LFX Mentorship (antigo CommunityBridge)community_bridge: PROJECT-NAME
Sponsors: USERNAME ou : [USERNAME, USERNAME, USERNAME, USERNAME]
IssueHuntissuehunt: USERNAME
Ko-fiko_fi: USERNAME
Liberapayliberapay: USERNAME
Open Collectiveopen_collective: USERNAME
: USERNAME
Tidelifttidelift: PLATFORM-NAME/PACKAGE-NAME
Polarpolar: USERNAME
Compre-me um cafébuy_me_a_coffee: USERNAME
thanks.devthanks_dev: u/gh/USERNAME
URL personalizadacustom: LINK1 ou custom: [LINK1, LINK2, LINK3, LINK4]

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

IdiomaNome da plataforma
JavaScriptnpm
Pythonpypi
Rubyrubygems
Javamaven
PHPpackagist
C#nuget

Veja um arquivo FUNDING.yml de exemplo:

: [octocat, surftocat]
: 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 saber mais, confira Como criar um arquivo padrão de integridade da comunidade.

Observação

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 .

Qualquer pessoa com permissões de administrador pode habilitar um botão de patrocinador em um repositório.

  1. Em , acesse a página principal do repositório.

  2. 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.

    Captura de tela de um cabeçalho de repositório que mostra as guias. A guia "Configurações" é realçada por um contorno laranja-escuro.

  3. Na página de configurações "Geral", na seção "Recursos", selecione Patrocínios.

  4. Na caixa "Patrocínios", clique no botão Configurar patrocinador ou Substituir links de financiamento.

  5. No editor de arquivos, siga as instruções descritas no arquivo FUNDING.yml para adicionar links aos locais de financiamento.

  6. Clique em Fazer commit das alterações...

  7. 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 saber mais, confira Criar um commit com vários autores.

  8. 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 saber mais, confira Como criar uma solicitação de pull.

    Captura de tela de uma solicitação de pull do GitHub que mostra um botão de opção para fazer commit diretamente na ramificação principal ou para criar um branch. O novo branch está selecionado.

  9. Clique em Fazer commit de alterações ou em Propor alterações.