Aller au contenu principal

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

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

Projets

Il existe 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 brève 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

La Webapp 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

Version manager that power CI/CD to uppdate apps.

Langages : JavaScript

  • Consultez le guide de style.

  • Demandez de l'aide dans le salon de discussion communautaire.

  • Lorsque vous travaillez sur un issue, mentionnez-le dans les commentaires de l' avant issue dès que vous commencez.

  • Pour une 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'il existe un issue lié et qu'il est référencé 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 et fautes 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 accord avec code. Cela permet de garantir que code et la documentation sont étroitement liées.

JavaScript et TypeScript

Toutes les API et tous les types exposés publiquement, le capacitor-updater module doivent disposer d'une documentation JSDoc. Cette documentation est analysée et disponible pour le compilateur TypeScript, ce qui facilite sa transmission en aval. Les blocs JSDoc se placent juste avant l'instruction concernée et sont indiqués par un /** avant de se terminer par un */. Par exemple :

export const FOO = "foo";

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