Passer au contenu principal
Capgo logo

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ôtoirs 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 qui 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 la Capgo

capacitor-updater

__CAPGO_KEEP_0__ capacitor-updater Plugin.

Vous souhaitez corriger un bug ou ajouter une nouvelle fonctionnalité à capacitor-updater? C'est le dépôt auquel vous souhaitez contribuer.

Langues : Swift, JavaScript, La plateforme cloud __CAPGO_KEEP_0__ composée de l'application web et des fonctions sans serveur.

capgo

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

Share where you want to contribute to fix the backend of Capgo.

TypeScript Front-end pour la page officielle de Deno :.

website

Frontend for official Deno webpage: https://capgo.app/

Langues : TypeScript, HTML, 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 la guide de style.

  • Demandez de l'aide 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.

  • Lorsque vous travaillez sur une nouvelle fonctionnalité, créez un problème et discutez avec les autres contributeurs avant de commencer à 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 code de conduite de Rust (CoC). contact@petitsnuages.org.

Soumettre une demande de tirage

Avant de soumettre une demande de tirage à l'un quelconque des dépôts, assurez-vous que les étapes suivantes ont été accomplies :

  1. Donnez à la demande de tirage un titre décrivant.

Exemples de titres de demande de tirage bons :

  • 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 demande de tirage 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 de la PR.

  • Assurez-vous qu'il existe des tests qui couvrent les modifications.

Soumettre une PR à Capgo

En outre, assurez-vous que :

  1. bun run lint passent - 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)

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.

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 à laquelle ils s'appliquent et sont dénotés par un tiret de soulignement avant. /** avant de se terminer par un */. Par exemple :

export const FOO = "foo";

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