Ir al contenido principal

Colaboradores

Directrices para enviar contribuciones a la comunidad Celo.

Celo es de código abierto y acogemos con agrado la participación abierta. Nos esforzamos por cumplir nuestros Conceptos comunitarios siendo una comunidad abierta e integradora en la que todo el mundo se siente bienvenido y con capacidad para contribuir. Esto también significa seguir algunas reglas básicas y acatar el Código de conducta de Celo.

consejo

Puede consultar la lista de colaboradores activos en celo.org/about

Cómo contribuir​

Nuestra comunidad incluye un grupo de colaboradores que ayudan a desarrollar, escribir, traducir y mejorar Celo. Cualquiera es bienvenido a unirse a la comunidad y contribuir con sus habilidades para ayudar a potenciar a otros miembros de la comunidad y hacer crecer el ecosistema de Celo.

Orientaciones del colaborador​

Hay algunas reglas básicas para contribuir:

  • Los PRs (pull requests) son preferibles a los issues, especialmente para cambios pequeños como los errores tipográficos. Los issues deben utilizarse para las características que faltan y para los cambios de base amplia.
  • Para el trabajo en curso, utilice su propia rama lateral y no la rama maestra.
  • Para cantidades de trabajo no triviales, le animamos a que envíe PR con regularidad para solicitar comentarios.
  • Por favor, revise su trabajo antes de enviarlo. Los envíos con errores tipográficos, ortográficos y gramaticales no podrán fusionarse hasta que se hayan corregido.
  • Intente ser lo más objetivo posible y basarse en los hechos.

Enviando PRs​

Te animamos a que hagas PR (pull request) de tu trabajo con regularidad y frecuencia para solicitar comentarios y asegurarte de que todo el mundo tiene una idea de en qué estás trabajando. Si acabas de empezar, te sugerimos que crees un PR con "WIP" (Work In Progress) en el título y nos avises cuando esté listo para revisar en los comentarios.

🖥️ Código​

Los Code Contributors son desarrolladores de la comunidad Celo que contribuyen al monorepo Celo o al código central del protocolo. Ayudan a mejorar el protocolo y la infraestructura corrigiendo errores y diseñando nuevas funciones que contribuyen a mejorar la plataforma Celo.

Cómo empezar​

Busque un área que le interese y en la que le gustaría ayudar. Busque temas etiquetados como"good first issue", "help wanted" and "1 hour tasks" para empezar. Si quieres profundizar más, no dudes en mirar otras etiquetas y TODO's en los comentarios del código. Si hay un tema al que te interese contribuir o del que te quieras hacer cargo, asígnate a él y añade un comentario con tus planes para abordarlo y el calendario previsto. Si ya hay alguien asignado, consulta con él antes de añadirte a la lista de asignados.

Las tareas van de mejoras menores a mayores. En función de sus intereses, habilidades y nivel de comodidad con la base de código, siéntase libre de contribuir donde considere oportuno. Lo único que le pedimos es que siga las directrices que figuran a continuación para garantizar una colaboración fluida y eficaz.

Asegúrese de que su PR​

  • Solicita los revisores adecuados. En caso de duda, consulte el archivo CODEOWNERS para obtener sugerencias.
  • Proporciona una descripción exhaustiva del problema abordado y de los cambios realizados.
  • Explica las dependencias y los cambios incompatibles hacia atrás.
  • Contiene pruebas unitarias y de extremo a extremo y una descripción de cómo se ejecutaron.
  • Incluye cambios en la documentación pertinente.

Si va a enviar una incidencia, compruebe que no exista ya una incidencia para el trabajo que tiene en mente.

Por favor, asegúrese de que su issue​

  • Se crea en el repositorio correcto.
  • Tiene un título claro y detallado para que no pueda confundirse con otros asuntos de Celo.
  • Proporciona una descripción exhaustiva del comportamiento actual y esperado, incluyendo, si procede, enlaces a referencias externas y directrices de aplicación específicas.
  • Se marca con las etiquetas correspondientes.
  • Se asigna si usted u otra persona ya está trabajando en ello.

🤝 CIPs​

Las propuestas de mejora de Celo (CIP) describen las normas para la plataforma Celo, incluidas las especificaciones del protocolo central, el SDK y las normas contractuales. Un CIP es un documento de diseño que debe aportar información de fondo, una justificación de la propuesta, una solución detallada que incluya especificaciones técnicas y, en su caso, una lista de riesgos potenciales. El proponente es responsable de solicitar la opinión de la comunidad y de impulsar el consenso.

Presentación de los CIPs​

Redacte todas las propuestas siguiendo la plantilla que figura a continuación y envíelas al repositorio CIPs a través de un PR (pull request).

Plantilla CIP​

  • Resumen: Describe tu propuesta en 280 caracteres o menos.
  • Descripción: Proporcione una breve descripción de la cuestión técnica que se aborda.
  • Motivación: Explique claramente por qué debe realizarse el cambio propuesto. Debe exponer las deficiencias actuales del protocolo Celo que aborda y por qué es importante hacerlo.
  • Especificación: Definir y explicar detalladamente los requisitos técnicos de las nuevas funcionalidades y/o cambios propuestos.
  • Razonamiento: Explique el razonamiento en el que se basa su planteamiento. Debe abarcar los enfoques alternativos considerados, los trabajos relacionados y las compensaciones realizadas.
  • Implementación: Para todas las propuestas que pasen por el proceso de gobernanza, esta sección debe hacer referencia al código que implementa el cambio propuesto. Se recomienda obtener la opinión de la comunidad antes de escribir cualquier código.
  • Riesgos: Destaca cualquier riesgo y preocupación que pueda afectar al consenso, la prueba de participación, la gobernanza, la economía del protocolo, el protocolo de estabilidad, la seguridad y la privacidad.

📄 Documentos​

Los redactores técnicos apoyan a la comunidad de Celo informando a los desarrolladores sobre Celo a través de una documentación atractiva, informativa y perspicaz.

Ver el video ↗️

Editar una página existente​

Para editar una página existente en la documentación, cree un fork del repositorio, confirme sus ediciones y envíe un PR.

  • Vaya a la página en los documentos
  • Haga clic en Edit this page en la parte inferior de la página
  • Editar la página directamente en GitHub
  • Describir la edición en el commit
  • Seleccione “Create a new branch and start a pull request”
  • Describa los cambios en el Pull Request (PR)
  • Selecciona "joenyzio" como revisor
  • Los cambios deben ser aprobados y pasar todas las comprobaciones de construcción del sitio antes de ser fusionados.

Añadir/eliminar páginas​

Para añadir una nueva página a la documentación, cree un fork, añada las nuevas páginas y actualice el archivo del índice para incluir sus nuevas páginas en la ubicación adecuada y envíe un PR.

  • Añadir o eliminar páginas directamente en Github
  • Coloca las nuevas páginas donde creas que tiene más sentido, podemos moverlas más tarde
  • Cree un PR para que sus cambios se añadan a la versión activa del sitio
  • Actualice el archivo llamado "sidebars.js" en la carpeta principal
  • Este archivo contiene el diseño del sitio que se ve en la parte izquierda del sitio docs
  • Añadir o eliminar los archivos correspondientes de la lista

🎓 Tutoriales​

Escribe sobre tu experiencia como miembro de la comunidad Celo, ya seas propietario de CELO, desarrollador o fundador de un proyecto. Tu experiencia y perspectiva son valiosas y pueden ayudar a otros.

Nombres de los archivos​

Crear una nueva entrada en el blog es muy sencillo. Crea un nuevo archivo en el directorio blog del repositorio de documentación. Los nombres de los archivos siguen el formato YYYY-MM-DD-post-name.md. Por ejemplo, este post fue escrito el 8 de noviembre de 2021, por lo que tiene el nombre de archivo 2021-11-08-contributing.md.

Portada​

Los posts se escriben en Markdown. Los puestos incluyen la portada. La portada son los metadatos que aparecen en la parte superior del archivo y que proporcionan más información sobre el post. La portada de este post tiene este aspecto:

---
title: Contributing to the Blog
description: How to contribute to the blog
slug: blog-contributions
authors:
  - name: Josh Crites
    title: Developer Relations, cLabs
    url: https://github.com/critesjosh
    image_url: https://github.com/critesjosh.png
tags: [contribute]
image: https://i.imgur.com/mErPwqL.png
hide_table_of_contents: false
---

Resumen del post​

Las páginas también pueden incluir una etiqueta <!--truncate--> que especifique qué texto se mostrará junto con el título de la entrada en la página de la lista de entradas. Cualquier texto por encima de <!--truncate--> aparecerá como resumen del post.

Añadiendo activos estáticos​

Si desea incluir imágenes u otros recursos estáticos en una entrada, puede crear una carpeta siguiendo la convención de nomenclatura descrita anteriormente (YYYY-MM-DD-post-name). El contenido de la carpeta puede incluir las imágenes y el post (con nombre de archivo index.md).

🌐 Traducciones​

Los traductores apoyan a la comunidad expandiendo el Celo a comunidades que no hablan inglés, traduciendo y compartiendo contenido en diferentes idiomas.

Cómo contribuir​

  • Ir a https://celo.crowdin.com/
  • Crea una cuenta
  • Empieza a traducir!
  • Enviar preguntas con los mensajes de Crowdin
  • Formulario de solicitud de traducción
consejo

Para preguntas, comentarios y debates, utilice el Celo Forum o Discord.