Nos alegra y apreciamos todos los contribuyentes a Capgo.
Esta página sirve como una ayuda para que comiences a contribuir.
Proyectos
Hay numerosos repositorios en el Capgo organizaciones que forman parte del ecosistema de Capgo.
Los repositorios tienen diferentes alcances, utilizan diferentes idiomas de programación y tienen diferentes niveles de contribución.
Para ayudarte a decidir qué repositorio podría ser el mejor para empezar a contribuir (y/o que se ajuste a tus intereses), aquí tienes una comparación breve (<strong> los idiomas en negrita comprenden la mayoría del código base </strong>):
Capgo
capacitor-updater
Este es el repositorio principal que proporciona el capacitor-updater Plugin.
¿Quieres corregir un bug o agregar una nueva característica a capacitor-updater? Este es el repositorio al que deseas contribuir.
Idiomas: Swift, JavaScript, Java
capgo
La aplicación web y las funciones serverless que componen la plataforma en la nube de Capgo.
Comparta dónde quiere contribuir para solucionar el backend de Capgo.
Idiomas: TypeScript.
website
Frontend para la página oficial de Deno: https://capgo.app/
Idiomas: TypeScriptHTML, CSS
docs
Documentación en Markdown que alimenta https://docs.capgo.app
Idiomas: Markdown
capacitor-standard-version
Administrador de versiones que impulsa CI/CD para actualizar aplicaciones.
Idiomas: JavaScript
-
Lee el guía de estilo.
-
Pide ayuda en la habitación de chat de la comunidad.
-
Cuando trabajas en un problema, menciona eso en los comentarios del problema antes de que comiences a trabajar en el problema.
-
Cuando trabajas en una nueva característica, crea un problema y discute con otros contribuyentes antes Comienza a trabajar en la característica; apreciamos todos los contribuyentes, pero no todas las características propuestas se aceptan. No queremos que pases horas trabajando en un code que podría no ser aceptado.
-
Por favor, sé profesional en los foros. Seguimos Rust's code of conduct (CoC). ¿Tienes un problema? Envía un correo electrónico a ry@tinyclouds.org.
Enviar una solicitud de extracción
Antes de enviar una solicitud de extracción a cualquier repositorio, asegúrate de que lo siguiente esté hecho:
- Dale un título descriptivo a la solicitud de extracción.
Ejemplos de titulares de solicitud de extracción buenos:
- fix(std/http): Corrige la condición de carrera en el servidor
- docs(console): Actualiza las documentaciones
- feat(doc): Maneja las reexportaciones anidadas
Ejemplos de título de PR malo:
- corregir #7123
- actualizar documentos
-
corregir errores
-
Asegúrese de que exista un problema relacionado y se refiera en el texto del PR.
- Asegúrese de que haya pruebas que cubran los cambios.
Enviar un PR a Capgo
Además de lo anterior, asegúrese de que:
bun run lintpase - esto verificará Rust y JavaScript code para comunes errores y errores utilizandoSwiftlint(para Swift) yeslint(para JavaScript y Java)
Documentar APIs
Es importante documentar todas las APIs públicas y queremos hacerlo inline con el code. Esto ayuda a asegurarse de que code y la documentación estén estrechamente acoplados.
JavaScript y TypeScript
Todos los APIs y tipos expuestos públicamente, el capacitor-updater módulo debe tener documentación de JSDoc. Esta documentación se analiza y está disponible para el compilador de TypeScript, y por lo tanto es fácil proporcionar más información downstream. Los bloques de JSDoc vienen justo antes de la declaración a la que se aplican y se denotan con un /** antes de terminar con un */Por ejemplo:
export const FOO = "foo";
Encuentra más en: https://jsdoc.app/