Skip to main content

Botón para mostrar un patrocinador en tu repositorio

Puedes agregar un botón de patrocinador en tu repositorio para aumentar la visibilidad de las opciones de financiación para tu proyecto de código abierto.

Acerca de los archivos FUNDING

Puede configurar el botón de patrocinador si edita un archivo FUNDING.yml en la carpeta .github del repositorio, en la rama predeterminada. Puedes configurar el botón para que incluya programadores patrocinados en GitHub Sponsors, plataformas de financiamiento externo o URL de financiamiento personalizadas. Para más información sobre GitHub Sponsors, consulta "Acerca de los Patrocinadores de GitHub".

Puedes agregar un nombre de usuario, un nombre de paquete o un nombre de proyecto por plataforma de financiamiento externo y hasta cuatro URL personalizadas. Puede añadir una organización y hasta cuatro desarrolladores patrocinadores en GitHub Sponsors. Agrega cada plataforma en una línea nueva, usando la siguiente sintaxis:

PlataformaSintaxis
LFX Mentorship (antes CommunityBridge)community_bridge: PROJECT-NAME
GitHub Sponsorsgithub: USERNAME o github: [USERNAME, USERNAME, USERNAME, USERNAME]
IssueHuntissuehunt: USERNAME
Ko-fiko_fi: USERNAME
Liberapayliberapay: USERNAME
Open Collectiveopen_collective: USERNAME
Patreonpatreon: USERNAME
Tidelifttidelift: PLATFORM-NAME/PACKAGE-NAME
Polarpolar: USERNAME
Comprarme un cafébuy_me_a_coffee: USERNAME
thanks.devthanks_dev: USERNAME
Dirección URL personalizadacustom: LINK1 o custom: [LINK1, LINK2, LINK3, LINK4]

Para Tidelift, usa la sintaxis platform-name/package-name con los siguientes nombres de plataforma:

IdiomaNombre de la plataforma.
JavaScriptnpm
Pythonpypi
Rubyrubygems
Javamaven
PHPpackagist
C#nuget

Este es un archivo FUNDING.yml de ejemplo:

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

Nota: Si una dirección URL personalizada de una matriz incluye :, debe encapsular la dirección URL entre comillas. Por ejemplo, "https://www.paypal.me/octocat".

Puedes crear un botón de patrocinador predeterminado para tu organización o cuenta personal. Para obtener más información, vea «Creación de un archivo predeterminado de mantenimiento de la comunidad».

Los enlaces de financiamiento permiten que los proyectos de código abierto reciban apoyo financiero directo de su comunidad. El uso de enlaces de financiamiento para otros fines, como la publicidad o el apoyo a grupos solidarios, comunitarios o políticos no está admitido. Si tienes consultas acerca de si los fines con que deseas usar estos enlaces están admitidos, ve a Soporte de GitHub.

Botón para mostrar un patrocinador en tu repositorio

Cualquier usuario que cuente con permisos de administración puede habilitar un botón de patrocinador en un repositorio.

  1. En GitHub.com, navega a la página principal del repositorio.

  2. En el nombre del repositorio, haz clic en Configuración. Si no puedes ver la pestaña "Configuración", selecciona el menú desplegable y, a continuación, haz clic en Configuración.

    Captura de pantalla de un encabezado de repositorio en el que se muestran las pestañas. La pestaña "Configuración" está resaltada con un contorno naranja oscuro.

  3. En la página de configuración "General", en la sección "Características", selecciona Patrocinios.

  4. En el cuadro "Patrocinios", haz clic en el botón Configurar patrocinador o Invalidar vínculos de financiación.

  5. En el editor de archivos, siga la instrucciones del archivo FUNDING.yml para agregar vínculos a las ubicaciones de financiación.

  6. Haz clic en Confirmar cambios... .

  7. En el campo de "Mensaje de confirmación", escriba un mensaje de confirmación corto y significativo que describa la modificación que hizo en el archivo. Puedes atribuir el cambio a mas de un autor en el mensaje del mismo. Para obtener más información, vea «Crear una confirmación con distintos autores».

  8. Debajo de los campos para el mensaje de confirmación, decide si deseas agregar tu confirmación a la rama actual o a una rama nueva. Debajo de los campos del mensaje de confirmación, decide si deseas agregar tu confirmación a la rama actual o a una nueva rama. Si tu rama actual es la rama predeterminada, debes elegir crear una nueva rama para tu confirmación y después crear una solicitud de extracción. Para obtener más información, vea «Crear una solicitud de incorporación de cambios».

    Captura de pantalla de una solicitud de cambios de GitHub en la que se muestra un botón de radio para confirmar directamente en la rama principal o para crear una nueva rama. Aparece seleccionada la opción de rama nueva.

  9. Haz clic en Confirmar cambios o Proponer cambios.

Información adicional