Saltar al contenido principal

Agradecemos y valoramos todas las contribuciones a Capgo.

Esta página te servirá de guía para empezar a contribuir.

Proyectos

Hay numerosos repositorios en el Capgo organizaciones que forman parte del ecosistema Capgo.

Los repositorios tienen distintos alcances, usan diferentes lenguajes y varían en cuanto a su nivel de contribución.

Para ayudarte a decidir qué repositorio es mejor para empezar (o cuál te interesa más), aquí tienes una comparativa corta (<strong> los lenguajes en negrita representan la mayor parte del codebase </strong>): Capgo

capacitor-updater

Este es el repositorio principal que ofrece el capacitor-updater Plugin.

Si quieres corregir un bug o añadir una nueva feature a capacitor-updater? Este es el repositorio al que quieres contribuir.

Lenguajes: Swift, JavaScript, Java

capgo

La Webapp y las serverless functions que componen la plataforma cloud de Capgo.

Dinos en qué parte quieres contribuir para mejorar el backend de Capgo.

Lenguajes: TypeScript.

website

Frontend de la web oficial de Deno: https://capgo.app/

Lenguajes: TypeScript, HTML, CSS

docs

Documentación en Markdown que alimenta https://docs.capgo.app

Lenguajes: Markdown

capacitor-standard-version

Gestor de versiones que impulsa el CI/CD para actualizar apps.

Lenguajes: JavaScript

  • Lee la guía de estilo.

  • Pide ayuda en el chat de la comunidad.

  • Cuando trabajes en un issue, menciónalo en los comentarios antes empieces a trabajar en el issue.

  • Cuando trabajes en una nueva feature, crea un issue y discútelo con otros colaboradores antes empiezas a trabajar en la funcionalidad; agradecemos todas las contribuciones, pero no todas las propuestas se aceptan. No queremos que pierdas horas trabajando en un code que podría no ser aceptado.

  • Sé profesional en los foros. Seguimos el code de conducta de Rust (CoC). ¿Tienes algún problema? Escribe a ry@tinyclouds.org.

Enviar un pull request

Antes de enviar un PR a cualquiera de los repos, asegúrate de cumplir con lo siguiente:

  1. Pon un título descriptivo al PR.

Ejemplos de buenos títulos de PR:

  • fix(std/http): Corregir condición de carrera en el servidor
  • docs(console): Actualizar docstrings
  • feat(doc): Manejar re-exports anidados

Ejemplos de títulos de PR incorrectos:

  • solucionar #7123
  • actualizar docs

  • corregir errores

  • Asegúrate de que exista un issue relacionado y que se mencione en el texto del PR.

  • Asegúrate de incluir tests que cubran los cambios.

Enviar un PR a Capgo

Además de lo anterior, asegúrate de que:

  1. bun run lint pase - esto verificará el code de Rust y JavaScript en busca de errores comunes usando Swiftlint (para Swift) y eslint (para JavaScript y Java)

Documentar APIs

Es importante documentar todas las APIs públicas y queremos hacerlo en línea con code. Esto ayuda a garantizar que code y la documentación estén estrechamente vinculados.

JavaScript y TypeScript

Todas las APIs y tipos expuestos públicamente, el capacitor-updater módulo debe tener documentación JSDoc. Esta documentación se analiza y está disponible para el compilador de TypeScript, lo que facilita su uso posterior. Los bloques JSDoc van justo antes de la declaración a la que se aplican y se indican con un /** antes de terminar con un */. Por ejemplo:

export const FOO = "foo";

Más información en: Encuentra más en https://jsdoc.app/