Passer à la navigation principale

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 le Capgo organisation faisant partie de l'écosystème Capgo.

Les dépôts ont différents champs d'application, utilisent différents langages de programmation et ont des niveaux de contribution différents.

To help you decide which dépôt pourrait être le meilleur pour commencer à contribuer (et/ou correspond à votre intérêt), voici une courte comparaison (<strong> les langages en gras constituent la plupart du codebase </strong>): Capgo

capacitor-updater

Ceci est le dépôt principal qui fournit le capacitor-updater Plugin.

You want to fix a bug or add a new feature to capacitor-updater? C'est le dépôt auquel vous souhaitez contribuer.

Langages: Swift, JavaScript, Java

capgo

La plateforme cloud de 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

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

Langues : TypeScriptHTML, CSS

docs

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

Langues : Markdown

capacitor-standard-version

https://docs.__CAPGO_KEEP_0__.app/

Langages : JavaScript

  • Lisez le guide de style.

  • guide de style. salon de discussion de la communauté.

  • When you work on an issue, mention so in the issue comments context salle de discussion de la communauté.

  • Lorsque vous travaillez sur une nouvelle fonctionnalité, créez un problème et discutez avec d'autres contributeurs. context you start working on the feature; we appreciate all contributions, but not all proposed features are getting accepted. We don't want you to spend hours working on a code that might not be accepted.

  • Soyez professionnels dans les forums. Nous suivons Rust's code de conduite (CoC). Avez-vous un problème ? Envoyez un e-mail contactez-nous à ry@tinyclouds.org.

Soumettre une demande de tirage

Avant de soumettre une PR à l'un des dépôts, assurez-vous que les éléments suivants sont effectués :

  1. Donnez à la PR un titre descriptif.

Exemples de bons titres de PR :

  • 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 mauvais titres de PR :

  • fix #7123
  • update docs

  • fix bugs

  • 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 Capgo

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

  1. bun run lint Ce processus vérifie Rust et JavaScript code pour les erreurs et les fautes courantes. Swiftlint Pour Swift et eslint (pour JavaScript et Java)

Documenter les APIs

Il est essentiel de documenter toutes les API publiques et nous souhaitons le faire de manière intégrée avec le code. Cela garantit que les code et la documentation soient étroitement liés.

JavaScript et TypeScript

Tous les APIs et types publics, ainsi que les capacitor-updater Le module doit avoir une documentation JSDoc. Cette documentation est analysée et disponible pour le compilateur TypeScript, ce qui facilite la fourniture de plus amples informations ultérieurement. Les blocs JSDoc se situent juste avant la déclaration qu'ils s'appliquent à et sont dénotés par une mise en forme avant la déclaration qui s'achève par /** avant de se terminer par un */. Par exemple :

export const FOO = "foo";

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