Passer au contenu principal
Capgo logo

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 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>):

Il s'agit du 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 :

Contributions Swift, JavaScript, Java

capgo

La plateforme cloud Capgo composée de l'application 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 web 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 alimente 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 avant de commencer à travailler sur le problème.

  • Lorsque vous travaillez sur une nouvelle fonctionnalité, créez un problème et discutez avec d'autres contributeurs avant de commencer à 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 à 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 email à ry@tinyclouds.org.

Soumettre une demande de tirage

Avant de soumettre une demande de PR à l'un des dépôts, veillez à ce que les éléments suivants soient effectués :

  1. Donnez au PR un titre descriptif.

Exemples de titres de PR de bonne qualité :

  • fix(std/http): Corriger la condition de course dans le serveur
  • docs(console): Mettre à jour les docstrings
  • 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

En outre, assurez-vous que :

  1. bun run lint vérifiez - 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)

Documentation des API

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

JavaScript et TypeScript

Toutes les API 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 loin. Les blocs JSDoc viennent juste avant la déclaration à laquelle 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/