Nous accueillons et apprécions tous les contributions à Capgo.

Cette page vous aide à vous lancer dans la contribution.

Projets

Il existe de nombreux dépôts dans l'organisation qui font partie de l'écosystème __CAPGO_KEEP_0__. Capgo Nous vous invitons à contribuer à Capgo.

Les dépôts ont différents champs d'application, utilisent différents langages de programmation et ont des niveaux de contribution variables.

Pour vous aider à décider quel dépôt pourrait être le mieux à contribuer (et/ou correspond à vos intérêts), voici une comparaison succincte (<strong> les langages en gras composent la plus grande partie du codebase </strong>): Capgo

capacitor-updater

C'est le dépôt principal qui fournit le capacitor-updater Plugin.

Vous souhaitez corriger un bug ou ajouter une nouvelle fonctionnalité à capacitor-updater? C'est le dépôt auquel vous souhaitez contribuer.

Langages : Swift, JavaScript, Java

capgo

La plateforme cloud Capgo composée des applications web et des fonctions sans serveur.

Partagez où vous souhaitez contribuer pour corriger l'arrière-plan de Capgo.

Langues : TypeScript.

website

Frontend pour la page officielle de Deno : https://capgo.app/

Langues : TypeScriptHTML, CSS

docs

Documentation en Markdown qui alimente https://docs.capgo.app

Langues : Markdown

capacitor-standard-version

Gestionnaire de version qui permet d'actualiser les applications CI/CD.

Langues : JavaScript

• Lisez le guide de style.

• Demandez de l'aide dans le salon de discussion de la communauté.

• Lorsque vous travaillez sur un problème, mentionnez-le dans les commentaires du problème. avant Vous commencez à travailler sur le problème.

• Lorsque vous travaillez sur une nouvelle fonctionnalité, créez un problème et discutez avec d'autres contributeurs. avant Vous commencez à travailler sur la fonctionnalité ; nous apprécions tous les contributions, mais toutes les fonctionnalités proposées ne sont pas acceptées. Nous ne voulons pas que vous passiez des heures à travailler sur un code qui pourrait ne pas être accepté.

• S'il vous plaît, soyez professionnel dans les forums. Nous suivons Rust's code of conduct (CoC). Avez-vous un problème ? Envoyez un courrier électronique à ry@tinyclouds.org.

Soumettre une demande de tirage

Avant de soumettre une PR à l'un des dépôts, assurez-vous que les étapes suivantes sont effectuées :

1. Donnez à la PR un titre décrivant.

Exemples de bons titres PR :

• fix(std/http) : Corriger la condition de course sur le serveur
• docs(console) : Mettre à jour les docstrings
• feat(doc) : Gérer les re-exports imbriqués

Exemples de titres PR mauvais :

• fix #7123
• mettre à jour les documents

• corriger les bogues

• Assurez-vous qu'il existe un problème lié et qu'il est référencé dans le texte du PR.

• Assurez-vous qu'il existe des tests qui couvrent les modifications.

Soumettre un PR à Capgo

En outre, assurez-vous que :

1. npm run lint passent - cela vérifiera le Rust et le JavaScript code pour les erreurs courantes et les erreurs en utilisant Swiftlint (pour Swift) et eslint (pour JavaScript et Java)

Documenter les API

Il est important de documenter toutes les API publiques et nous voulons le faire inline avec le code. Cela nous aide à nous assurer que code et la documentation sont étroitement liés.

JavaScript et TypeScript

Tous les APIs et types exposés publiquement, ainsi que le module, doivent avoir une documentation JSDoc. Cette documentation est analysée et disponible pour le compilateur TypeScript, et est donc facile à fournir plus loin dans la chaîne. Les blocs JSDoc viennent juste avant la déclaration à laquelle ils s'appliquent et sont dénotés par une ligne de capacitor-updater avant de se terminer par un /** . Par exemple : */Trouvez plus d'informations sur :

export const FOO = "foo";
        

https://jsdoc.app/ Bas de page