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

Cette page vous aide à démarrer dans la contribution.

Projets

Il existe de nombreux dépôtoires 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 mieux à contribuer (et/ou correspond à vos intérêts), voici une comparaison succincte (<strong> les langages en gras constituent la majeure 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:

organisation Swift, JavaScript, Java

capgo

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

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

Langues : TypeScript.

website

Front-end pour la page officielle de Deno : https://capgo.app/

Langues : TypeScript, HTML, CSS

docs

La documentation en Markdown qui alimente https://docs.capgo.app

Langues : Markdown

capacitor-standard-version

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

Langues : JavaScript

• Lisez le guide de style.

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

• Mentionnez l'issue avant de travailler dessus. 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 tous 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, veuillez vous assurer que les éléments suivants sont réalisés :

1. Accordez à la PR un titre descriptif.

Exemples de titres de PR de qualité :

• fix(std/http): Corriger une 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 de mauvaise qualité :

• 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

De plus, assurez-vous que :

1. bun run lint passages - 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 API

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

JavaScript et TypeScript

Toutes les API et types exposés publiquement, les capacitor-updater le module devrait 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/