Skip to main content

Affichage d’un bouton Sponsor dans votre dépôt

Vous pouvez ajouter un bouton Sponsor dans votre dépôt pour accroître la visibilité des options de financement de votre projet open source.

À propos des fichiers FUNDING

Vous pouvez configurer votre bouton Sponsor en modifiant un fichier FUNDING.yml dans le dossier .github votre dépôt, sur la branche par défaut. Vous pouvez configurer le bouton pour inclure des développeurs sponsorisés dans GitHub Sponsors, des plateformes de financement externes ou une URL de financement personnalisée. Pour plus d’informations sur GitHub Sponsors, consultez « À propos de GitHub Sponsors ».

Vous pouvez ajouter un nom d’utilisateur, un nom de package ou un nom de projet par plateforme de financement externe et jusqu’à quatre URL personnalisées. Vous pouvez ajouter une organisation et jusqu’à quatre développeurs sponsorisés dans GitHub Sponsors. Ajoutez chaque plateforme sur une nouvelle ligne, avec la syntaxe suivante.

PlateformeSyntaxe
LFX Mentorship (anciennement 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
Patreonpatreon: USERNAME
Tidelifttidelift: PLATFORM-NAME/PACKAGE-NAME
Polairepolar: USERNAME
Buy Me a Coffeebuy_me_a_coffee: USERNAME
thanks.devthanks_dev: USERNAME
URL personnaliséecustom: LINK1 ou custom: [LINK1, LINK2, LINK3, LINK4]

Pour Tidelift, utilisez la syntaxe platform-name/package-name avec les noms de plateforme suivants.

LangageNom de la plateforme
JavaScriptnpm
Pythonpypi
Rubyrubygems
Javamaven
PHPpackagist
C#nuget

Voici un exemple de fichier FUNDING.yml :

github: [octocat, surftocat]
patreon: octocat
tidelift: npm/octo-package
custom: ["https://www.paypal.me/octocat", octocat.com]

Remarque : si une URL personnalisée dans un tableau inclut :, vous devez l’encapsuler entre guillemets. Par exemple : "https://www.paypal.me/octocat".

Vous pouvez créer un sponsor par défaut pour votre organisation ou votre compte personnel. Pour plus d’informations, consultez « Création d’un fichier d’intégrité de la communauté par défaut ».

Les liens de financement permettent à des projets open source de recevoir un soutien financier direct de leur communauté. Nous ne prenons pas en charge l’utilisation de liens de financement à d’autres fins, comme pour faire de la publicité, ou soutenir des groupes politiques, communautaires ou de bienfaisance. Si vous avez des questions sur la prise en charge de votre utilisation prévue, veuillez visiter Support GitHub.

Affichage d’un bouton Sponsor dans votre dépôt

Toute personne disposant d’autorisations d’administration peut activer un bouton Sponsor dans un dépôt.

  1. Sur GitHub, accédez à la page principale du référentiel.

  2. Sous le nom de votre dépôt, cliquez sur Paramètres. Si vous ne voyez pas l’onglet « Paramètres », sélectionnez le menu déroulant , puis cliquez sur Paramètres.

    Capture d’écran d’un en-tête de dépôt montrant les onglets. L’onglet « Paramètres » est mis en évidence avec un encadré orange foncé.

  3. Dans la page des paramètres « Général », dans la section « Fonctionnalités », sélectionnez Sponsorisations.

  4. Dans la zone « Sponsorisations », cliquez sur Configurer un bouton Sponsor ou Remplacer des liens de financement.

  5. Dans l’éditeur de fichier, suivez les instructions du fichier FUNDING.yml pour ajouter des liens à vos emplacements de financement.

  6. Cliquez sur Valider les modifications...

  7. Dans le champ de message de validation, tapez un message de validation court et descriptif qui indique la modification que vous avez apportée au fichier. Vous pouvez attribuer la validation à plusieurs auteurs dans le message de validation. Pour plus d’informations, consultez « Création d’une validation avec plusieurs auteurs ».

  8. Sous les champs de message de commit, choisissez si vous souhaitez ajouter votre commit à la branche actuelle ou à une nouvelle branche. Si votre branche actuelle est la branche par défaut, vous devez choisir de créer une branche pour votre validation, puis de créer une demande de tirage (pull request). Pour plus d’informations, consultez « Création d’une demande de tirage ».

    Capture d’écran d’une demande de tirage GitHub montrant une case d’option permettant de commiter directement dans la branche main ou de créer une branche. Une nouvelle branche est sélectionnée.

  9. Cliquez sur Valider les modifications ou Proposer des modifications.

Pour aller plus loin