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

Cette page sert de guide pour vous aider à commencer à contribuer.

Projets

Il existe de nombreux dépôts dans l'organisation qui font partie de l'écosystème __CAPGO_KEEP_0__. Capgo organization that are part of the Capgo ecosystem.

Pour vous aider à décider quel dépôt pourrait être le meilleur pour commencer à 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>):

C'est le dépôt principal qui fournit le Capgo

capacitor-updater

plugin. capacitor-updater Vous souhaitez corriger un bug ou ajouter une nouvelle fonctionnalité à

? C'est le dépôt auquel vous souhaitez contribuer. capacitor-updaterLangages :

Swift JavaScript, Contributions, Java

capgo

La plateforme cloud Capgo composée de l'application web et des fonctions sans serveur.

Partagez où vous souhaitez contribuer pour corriger le backend de Capgo.

Langues : TypeScript.

website

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

Langues : TypeScript, HTML, CSSLa documentation en Markdown qui alimente

docs

https://docs.__CAPGO_KEEP_0__.app https://docs.capgo.app

Langues : Markdown

capacitor-standard-version

Gestionnaire de version qui alimente la CI/CD pour mettre à jour les applications.

Langues : JavaScript

• Lisez le guide de style.

• Posez des questions dans la salle de discussion de la communauté.

• Lorsque vous travaillez sur un problème, mentionnez-le dans les commentaires du problème avant de commencer à travailler sur le problème. Mentionnez le problème avant de commencer à travailler dessus. Commencez à travailler sur le problème.

• When 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 e-mail à ry@tinyclouds.org.

Soumettre une demande de tirage

Avant de soumettre une PR à n'importe lequel des dépôts, veuillez vous assurer que les éléments suivants sont effectués :

1. Accordez à la PR un titre descriptif.

Exemples de titres de PR bien écrit :

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

Exemples de titres de 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. bun run lint passent - cela vérifiera le Rust et le JavaScript code pour les erreurs et les erreurs courantes en utilisant Swiftlint (pour Swift) et eslint (pour JavaScript et Java)

Documenter les APIs

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

JavaScript et TypeScript

Toutes les APIs et types exposés publiquement, le capacitor-updater module doit avoir une documentation JSDoc. Cette documentation est analysée et disponible pour le compilateur TypeScript, et donc facile à fournir plus en aval. Les blocs JSDoc viennent juste avant la déclaration qu'ils s'appliquent à et sont dénotés par un /** avant de se terminer par un */. Par exemple:

export const FOO = "foo";
        

Trouvez plus d'informations sur : https://jsdoc.app/