Contribución

⭐ CONTRIBUIR

Contribuyendo a Lightning Bounties

Primero que nada, gracias por tomarte el tiempo de contribuir! ❤️

Se valoran y alientan todo tipo de contribuciones. Consulta la Tabla de Contenidos para conocer las distintas formas de ayudar y detalles sobre cómo este proyecto las maneja. Por favor, asegúrate de leer la sección relevante antes de hacer tu contribución. Esto facilitará mucho las cosas para los que mantenemos el proyecto y suavizará la experiencia para todos los involucrados. La comunidad espera ansiosamente tus contribuciones. 🎉

Y si te gusta el proyecto, pero simplemente no tienes tiempo para contribuir, está bien. Existen otras formas sencillas de apoyar el proyecto y mostrar tu agradecimiento, lo que también nos alegraría mucho:

  • Dándole estrellas al proyecto

  • Tuiteando sobre él

  • Mencionando este proyecto en el readme de tu proyecto

  • Mencionando el proyecto en encuentros locales y contándoselo a tus amigos/colegas

Tabla de Contenidos

  • Tengo una Pregunta

  • Quiero Contribuir

    • Reportando Errorss

    • Sugiriendo Mejoras

    • Tu Primera Contribución de Código

    • Mejorando La Documentación

  • Guías de Estilo

    • Mensajes de Commit

  • Únete al Equipo del Proyecto

Tengo Una Pregunta

Si deseas hacer una pregunta, asumimos que ya has leído la Documentación disponible.

Antes de hacer una pregunta, es mejor buscar entre los Problemas existentes que podrían ayudarte. En caso de que hayas encontrado un problema adecuado y aún necesites aclaraciones, puedes escribir tu pregunta en este problema. También es recomendable buscar primero en internet respuestas.

Si aún sientes la necesidad de hacer una pregunta y necesitas aclaraciones, recomendamos lo siguiente:

  • Abre un Problema.

  • Proporciona tanto contexto como puedas sobre lo que te está pasando.

  • Proporciona las versiones del proyecto y de la plataforma (python, npm, etc.), según lo que parezca relevante.

Nosotros nos encargaremos del problema lo antes posible.

Quiero Contribuir

Aviso Legal

Al contribuir a este proyecto, debes estar de acuerdo en que tú has escrito el 100% del contenido, que tienes los derechos necesarios sobre el contenido y que el contenido que contribuyas puede ser proporcionado bajo la licencia del proyecto.

Reportando Errores

Antes de Enviar un Reporte de Error

Un buen reporte de error no debe dejar a otros necesitando perseguirte para obtener más información. Por lo tanto, te pedimos que investigues cuidadosamente, recopiles información y describas el problema en detalle en tu reporte. Por favor, completa los siguientes pasos con antelación para ayudarnos a solucionar cualquier posible error lo más rápido posible.

  • Asegúrate de que estás utilizando la última versión.

  • Determina si tu error es realmente un error y no un error de tu parte, por ejemplo, usando componentes/versiones de ambiente incompatibles (Asegúrate de haber leído la documentación. Si estás buscando soporte, quizá quieras revisar esta sección).

  • Para ver si otros usuarios han experimentado (y posiblemente ya han resuelto) el mismo problema que estás teniendo, verifica si no existe ya un reporte de error para tu error o problema en el rastreador de errores.

  • También asegúrate de buscar en internet (incluyendo Stack Overflow) para ver si los usuarios fuera de la comunidad de GitHub han discutido el problema.

  • Recopila información sobre el error:

    • Traza de pila (Traceback)

    • SO, Plataforma y versión (Windows, Linux, macOS, x86, ARM)

    • Versión del intérprete, compilador, SDK, entorno de tiempo de ejecución, gestor de paquetes, dependiendo de lo que parezca relevante.

    • Posiblemente tu entrada y la salida

    • ¿Puedes reproducir el problema de forma fiable? ¿Y también puedes reproducirlo con versiones anteriores?

¿Cómo Envío un Buen Reporte de Error?

Nunca debes reportar problemas de seguridad, vulnerabilidades o errores que incluyan información sensible en el rastreador de problemas, o en cualquier otra parte en público. En lugar de ello, los errores sensibles deben ser enviados por correo electrónico a .

Utilizamos problemas de GitHub para rastrear errores y errores. Si te encuentras con un problema con el proyecto:

  • Abre un Problema. (Ya que no podemos estar seguros en este punto si es un error o no, te pedimos que no hables de un error todavía y no etiquetes el problema).

  • Explica el comportamiento que esperarías y el comportamiento real.

  • Por favor, proporciona tanto contexto como sea posible y describe los pasos de reproducción que alguien más puede seguir para recrear el problema por su cuenta. Esto incluye habitualmente tu código. Para buenos reportes de errores deberías aislar el problema y crear un caso de prueba reducido.

  • Proporciona la información que recopilaste en la sección anterior.

Una vez que haya sido reportado:

  • El equipo del proyecto etiquetará el problema en consecuencia.

  • Un miembro del equipo intentará reproducir el problema con los pasos que proporcionaste. Si no hay pasos de reproducción o si no hay una forma obvia de reproducir el problema, el equipo te pedirá esos pasos y marcará el problema como necesita-repro'. Los errores con la etiqueta necesita-repro’ no serán atendidos hasta que sean reproducidos.

  • Si el equipo es capaz de reproducir el problema, será marcado como necesita-arreglo', así como posiblemente otras etiquetas (como crítico'), y el problema quedará pendiente de ser implementado por alguien.

Sugiriendo Mejoras

Esta sección te guiará a través de la presentación de una sugerencia de mejora para Lightning Bounties, incluyendo características completamente nuevas y mejoras menores a la funcionalidad existente. Seguir estas pautas ayudará a los responsables del mantenimiento y a la comunidad a comprender tu sugerencia y a encontrar sugerencias relacionadas.

Antes de Enviar una Mejora

  • Asegúrate de que estás utilizando la última versión.

  • Lee cuidadosamente la documentación y averigua si la funcionalidad ya está cubierta, quizá por una configuración individual.

  • Realiza una búsqueda para ver si la mejora ya ha sido sugerida. Si ya ha sido sugerida, añade un comentario al problema existente en lugar de abrir uno nuevo.

  • Averigua si tu idea se ajusta al alcance y a los objetivos del proyecto. Depende de ti exponer un fuerte caso para convencer a los desarrolladores del proyecto de los méritos de esta característica. Ten en cuenta que queremos características que sean útiles para la mayoría de nuestros usuarios y no sólo para un pequeño subconjunto. Si sólo estás apuntando a una minoría de usuarios, considera la posibilidad de escribir una biblioteca de complementos/plugins.

¿Cómo Envío una Buena Sugerencia de Mejora?

Las sugerencias de mejora se rastrean como problemas de GitHub.

  • Usa un título claro y descriptivo para el problema para identificar la sugerencia.

  • Proporciona una descripción paso a paso de la mejora sugerida con tantos detalles como sea posible.

  • Describe el comportamiento actual y explica qué comportamiento esperabas ver en cambio y por qué. En este punto también puedes mencionar qué alternativas no funcionan para ti.

  • Es posible que quieras incluir capturas de pantalla y GIFs animados que te ayuden a demostrar los pasos o a señalar la parte a la que se refiere la sugerencia. Puedes usar esta herramienta para grabar GIFs en macOS y Windows, y esta herramienta o esta herramienta en Linux.

  • Explica por qué esta mejora sería útil para la mayoría de los usuarios de Lightning Bounties. También puedes querer señalar otros proyectos que lo han resuelto mejor y que podrían servir de inspiración.

Tu Primera Contribución de Código

Para hacer tu primera contribución de código, sigue estos pasos:

  1. Haz Fork al Repositorio y Clónalo

    • Haz fork al repositorio en GitHub.

    • Clona el repositorio bifurcado en tu máquina local.

  2. Modifica el Código

    • Abre el archivo src/main.py y realiza los cambios deseados para reflejar tus modificaciones.

  3. Genera una Factura de Lightning

    • Genera una factura de lightning para el pago.

    • Copia la cadena de factura en el archivo reward.txt.

  4. Haz Commit y Envía una Pull Request

    • Añade y comenta tus cambios en el repositorio local.

    • Envía una pull request al repositorio base.

  5. Paga la Factura

    • Se desencadenará una acción de GitHub para solicitar un pago de "polvo" de ti (el contribuidor) al repositorio base (el propietario).

    • Elige la acción que dice "Por favor, paga la factura: lnbc10n1..." (no la que dice "Valores extraídos:...").

    • Espera la confirmación del pago.

    • Una vez que el pago está confirmado, recibirás un mensaje que dice "¡Gracias por tu pago!"

  6. Solicita un Revisor

    • Pide a un revisor que revise tu pull request.

    • Elige a Enrique o William para esta prueba.

  7. Revisión y Análisis

    • Después de unos segundos, se ejecutará una nueva acción.

    • Primero dirá "Se ha recibido el pago, espera, ejecutando la consulta openai".

    • Aproximadamente 30 segundos después, volverá con un resumen de tus cambios y un análisis de vulnerabilidad de seguridad.

  8. Mezclar la Pull Request

    • Estaremos atentos a tu pull request e intentaremos mezclarlo por ti. Como contribuidor, no tienes el poder de mezclarlo tú mismo.

Alternativamente, si prefieres replicar nuestro trabajo en tu propio repositorio:

  • Copia el contenido del directorio .github/ en tu repositorio.

  • Modifica el archivo main.py de acuerdo a tus necesidades.

  • Configura los siguientes secretos en la configuración de tu repositorio:

    • OPENAI_API_KEY

    • PAY_INVOICE_KEY (clave de administrador para LNBits)

    • WALLET_API_KEY (clave de factura/lectura para LNBits)

    • WALLET_BASE_URL (URL para tu instancia de LNBits)

Mejorando La Documentación

Si quieres mejorar la documentación, por favor sigue el mismo proceso que se describe en la sección "Tu Primera Contribución de Código", pero céntrate en actualizar los archivos de documentación en lugar del código.

Guías de Estilo

Mensajes de Commit

Al escribir mensajes de commit, por favor sigue estas directrices:

  • Usa tiempo presente ("Añade característica" no "Añadida característica")

  • Usa el modo imperativo ("Mueve el cursor a..." no "Mueve el cursor a...")

  • Limita la primera línea a 72 caracteres o menos

  • Menciona los problemas y las pull requests de forma liberal después de la primera línea

Únete al Equipo del Proyecto

Si estás interesado en unirte al equipo del proyecto, por favor contáctanos en founders@lightningbounties.com.

Atribución

Esta guía se basa en el contributing-gen. ¡Crea el tuyo!

Descargo de responsabilidad

!!! Advertencia "Versión Beta" Este proyecto está actualmente en beta y en desarrollo activo. El proceso de prueba descrito en este documento puede cambiar con frecuencia a medida que hagamos actualizaciones y mejoras.

Si tienes alguna pregunta o te gustaría discutir posibles contribuciones, por favor envíanos un correo electrónico a founders@lightningbounties.com.

Previouslightning network faqs_esNextLICENCIA.md

Last updated