Your Python Package CONTRIBUTING File#

El archivo CONTRIBUTING.md es la página de aterrizaje guía para los contribuidoresde tu proyecto. Delimita cómo participan los contribuidores, los tipos de contribucionesque aceptas, y cómo los constribuidores deberían interactuar o participar contigo y tu equipomantenedor. La guía para contribuidores también debería incluir enlaces a recursos de Introducciónque expliquen cómo configurar ambientes de desarrollos y qué tipo de flujos de trabajo se esperanen GitHub/GitLab, y cualquier otra cosa que los contribuidores necesiten para empezar.

Este archivo benefecia tanto a mantenedores como contribuidores. Para contribuidores, proveeuna hoja de ruta que les ayuda a empezar y hace su primera contribución más sencilla. Para mantenedores,responde preguntas frecuentemente realizadas y reduce la carga de explicar tu procesoa cada persona que quiere contribuir. Este documento crea un proceso de desarrollomás colaborativo y eficiente para todos.

Los archivos de contribución reducen barreras de acceso#

El archivos de contribución reduce barreras de acceso tanto para nuevos contribuidorescomo para experimentados, puesto que ofrece una guía

  • Para Contribuidores: Brinda Instrucciones claras en contribución, desde reportar problemas (issues) hasta enviar pull requests.

  • Para Mantenedores: Optimiza las aportaciones al establecer expectativasy estandarizar los procesos, lo que reduce el tiempo dedicado a aclarar dudas habitualeso a gestionar los problemas (issues) incompletos o pull requests

Incluir un archivo CONTRIBUTING.md bien escrito en tu proyecto es una manera de hacerlo mas acogedor y abierto a contribuidores nuevos y experimentados. También ayuda a crear un flujo de trabajo más continuo para todos los involucrados

Hazlo acogedor#

Haz la guía acogedora. Usa lenguaje accesible para incitarpariticpación de contribuidores de todos los niveles de experiencias.Por ejemplo:

  • Evita jergas técnicas o explica términos cuando sea necesario (por ejemplo, « bifurca (fork) el repositorio»).

  • Incluye una introducción amigable, como «¡Gracias por tu interés encontribuir! Estamos emocionados de colaborar contigo.»

  • Destaca todas las contribuciones, sin importar qué tan pequeñas sean, son valiosas

Lo que un archivo CONTRIBUTING.md debería contener#

Ejemplo archivos de contribución

Tu paquete de Python debería incluir un archivo llamado CONTRIBUTING.md localizado en la raíz de tu repositorio junto con tu archivo README.md .

El archivo CONTRIBUTING.md debería incluir información sobre:

  • Los tipos de contribuciones que aceptas

Ejemplo: Aceptamos contribuciones de todo tipo. Si quieres abordar un problema (issue)existente, revisa nuestros problemas (issues) en este repositorio y commenta en elque te gustaría ayudar. De otra forma, puede abrir un nuevo problema (issue)…

  • Cómo te gustaría que las contribuciones sucedieran. Explica con claridadtu proceso de contribución. Por ejemplo:

    • ¿Deberían los nuevos contribuidores abordar los problemas (issues) pendientes?

    • ¿Nuevos problemas (issues) son bienvenidos?

    • ¿Deberían los contribuidores abrir un pull request (PR) directamente o discutir cambios priemro?

  • Incluye Instrucciones sobre el flujo de trabajo de bifurcaciones (fork) y pull requests,así como enlaces a recursos o guías que expliquen estos pasos (si están disponibles).

  • Lineamientos que tengas para usuarios enviando problemas, pull requests, o haciendo preguntas.

If you have a development guide, link to it. This guide should provide clear instructions on how to set up your development environment locally. It also should overview CI tools that you have that could simplify the contribution process (for example, pre-commit.ci bot, and so on), linters, code formatters, and so on.

This guide should also include information for someone interested in asking questions. Some projects accept questions as GitHub or GitLab issues. Others use GitHub Discussions, Discourse, or even a Discord server.

The contributing file should also include:

Summary#

A well-crafted CONTRIBUTING.md file is welcome mat for your project! By providing clear instructions, helpful resources, and a welcoming tone, you make it easier for contributors to get involved and build a stronger, more collaborative community around your project.