Aller au contenu principal

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

Cette page est là pour vous aider à commencer à contribuer.

Projets

Il y a de nombreux dépôts dans le Capgo organisations qui font partie de l'écosystème Capgo.

Les dépôts ont des périmètres différents, utilisent divers langages de programmation et présentent des niveaux de contribution variés.

Pour vous aider à choisir le dépôt idéal pour commencer à contribuer (ou selon vos intérêts), voici une courte comparaison (<strong> les langages en gras constituent la majeure partie du code </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 fonctionnalité à capacitor-updater? C'est le dépôt auquel vous voulez contribuer.

Langages : Swift, JavaScript, Java

capgo

L'application web et les fonctions serverless qui composent la plateforme cloud Capgo.

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

Langages : TypeScript.

website

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

Langages : TypeScript, HTML, CSS

docs

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

Langages : Markdown

capacitor-standard-version

Gestionnaire de versions pour CI/CD et mises à jour d’apps.

Langages : JavaScript

  • Lire le guide de style.

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

  • Lorsque vous travaillez sur une issue, mentionnez-le dans les commentaires de l'issue avant avant de commencer à travailler sur l'issue.

  • Pour toute nouvelle fonctionnalité, créez une issue et discutez-en avec les autres contributeurs avant vous commencez à travailler sur la fonctionnalité ; nous apprécions toutes les contributions, mais toutes les fonctionnalités proposées ne sont pas acceptées. Nous ne voulons pas que vous passiez des heures sur un code qui pourrait ne pas être accepté.

  • Merci de rester professionnel sur les forums. Nous suivons le code de conduite code de Rust (CoC). Un problème ? Écrivez à ry@tinyclouds.org.

Soumettre une pull request

Avant de soumettre une PR sur l'un des repos, assurez-vous que les points suivants sont respectés :

  1. Donnez un titre descriptif à la PR.

Exemples de bons titres de PR :

  • fix(std/http): corriger une race condition dans le serveur
  • docs(console): mettre à jour les docstrings
  • feat(doc): Gérer les ré-exports imbriqués

Exemples de mauvais titres de PR :

  • corrige #7123
  • update docs
  • fix bugs

  • Assurez-vous qu'une issue liée existe et qu'elle est référencée dans le texte de la PR.

  • Assurez-vous que des tests couvrent les changements.

Soumettre une PR à Capgo

En plus de ce qui précède, assurez-vous que :

  1. bun run lint passe — cela vérifiera le code Rust et JavaScript pour détecter les erreurs courantes via Swiftlint (pour Swift) et eslint (pour JavaScript et Java)

Documenter les API

Il est essentiel de documenter toutes les API publiques, et nous souhaitons le faire directement dans le code. Cela permet de garantir que le code et la documentation restent étroitement liés.

JavaScript et TypeScript

Toutes les API et les types exposés publiquement, le capacitor-updater module doit être documenté avec JSDoc. Cette documentation est analysée et mise à disposition du compilateur TypeScript, ce qui facilite sa transmission en aval. Les blocs JSDoc sont placés juste avant la déclaration à laquelle ils s'appliquent et sont introduits par un /** avant de se terminer par un */. Par exemple :

export const FOO = "foo";
        

En savoir plus sur : https://jsdoc.app/