Damos la bienvenida y apreciamos todas las contribuciones a Capgo.
Esta página sirve como una guía para ayudarte a comenzar a contribuir.
Proyectos
Hay numerosos repositorios en la organización Capgo que son parte de Capgo.
Los repositorios tienen diferentes alcances, utilizan diferentes lenguajes de programación y tienen distintos niveles en lo que respecta a contribuciones.
Para ayudarte a decidir qué repositorio podría ser el mejor para comenzar a contribuir (y/o que se ajuste a tus intereses), aquí hay una breve comparación (<strong> los lenguajes en negrita comprenden la mayor parte de la base de código </strong>): Capgo
capacitor-updater
Este es el repositorio principal que proporciona el plugin capacitor-updater.
¿Quieres corregir un error o agregar una nueva función a capacitor-updater? Este es el repositorio al que deseas contribuir.
Languages: Swift, JavaScript, Java
capgo
La aplicación web y las funciones sin servidor que componen la plataforma en la nube de Capgo.
Ahí donde quieres contribuir para arreglar el backend de Capgo.
Languages: TypeScript.
website
Frontend para la página oficial de Deno: https://capgo.app/
Languages: TypeScript, HTML, CSS
docs
Documentación en Markdown que impulsa https://doc.capgo.app
Languages: Markdown
capacitor-standard-version
Administrador de versiones que potencia CI/CD para actualizar aplicaciones.
Languages: JavaScript
-
Lee la guía de estilo.
-
Pide ayuda en el chat de la comunidad.
-
Cuando trabajes en un problema, menciónalo en los comentarios del problema antes de que comiences a trabajar en él.
-
Cuando trabajes en una nueva función, crea un problema y discútelo con otros colaboradores antes de comenzar a trabajar en la función; apreciamos todas las contribuciones, pero no todas las funciones propuestas son aceptadas. No queremos que pierdas horas trabajando en un código que podría no ser aceptado.
-
Por favor, sean profesionales en los foros. Seguimos el código de conducta de Rust (CoC). ¿Tienes un problema? Envía un correo electrónico a ry@tinyclouds.org.
Enviando una solicitud de extracción
Antes de enviar un PR a cualquiera de los repositorios, por favor asegúrate de que lo siguiente esté hecho:
- Dale un título descriptivo al PR.
Ejemplos de un buen título de PR:
- fix(std/http): Fix race condition in server
- docs(console): Update docstrings
- feat(doc): Handle nested re-exports
Ejemplos de títulos de relaciones públicas malos:
- fix #7123
- update docs
-
fix bugs
-
Ensure there is a related issue and it is referenced in the PR text.
- Ensure there are tests that cover the changes.
Enviando un PR a Capgo
Además de lo anterior, asegúrate de que:
- `npm run lint` pasa - esto verificará el código de Rust y JavaScript en busca de errores y equivocaciones comunes utilizando `Swiftlint` (para Swift) y `eslint` (para JavaScript y Java)
Documentando APIs
Es importante documentar todas las API públicas y queremos hacerlo inline con el código. Esto ayuda a garantizar que el código y la documentación estén estrechamente relacionados.
JavaScript y TypeScript
Todas las API y tipos expuestos públicamente, el módulo capacitor-updater debería tener documentación JSDoc. Esta documentación se analiza y está disponible para el compilador de TypeScript, y por lo tanto es fácil de proporcionar más adelante. Los bloques JSDoc vienen justo antes de la declaración a la que se aplican y se denotan con un /** inicial antes de terminar con un */. Por ejemplo:
export const FOO = "foo";
Encuentra más en: https://jsdoc.app/