Capgo logo

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

Cette page sert de guide pour vous aider à démarrer votre contribution.

Projets

Il existe de nombreux dépôts dans l'organisation Capgo qui font partie de Capgo.

Les dépôts ont des portées différentes, utilisent différents langages de programmation et présentent des niveaux variables en matière de contributions.

Pour vous aider à décider quel dépôt pourrait être le meilleur pour commencer à contribuer (et/ou correspond à vos intérêts), voici une courte comparaison (les langages en gras composent la majeure partie du code) :

capacitor-updater

Voici le dépôt principal qui fournit le plugin capacitor-updater.

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

Languages: Swift, JavaScript, Java

capgo

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

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

Languages: TypeScript.

website

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

Languages: TypeScript, HTML, CSS

docs

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

Languages: Markdown

capacitor-standard-version

Gestionnaire de versions qui alimente la CI/CD pour mettre à jour les applications.

Languages: JavaScript

  • Lisez le guide de style.

  • Demandez de l'aide dans la salle de discussion communautaire.

  • Lorsque vous travaillez sur un problème, mentionnez-le dans les commentaires du problème avant de commencer à y travailler.

  • Lorsque vous travaillez sur une nouvelle fonctionnalité, créez un ticket 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é.

  • Veuillez rester professionnel sur les forums. Nous suivons le code de conduite de Rust (CoC). Vous avez un problème ? Envoyez un e-mail à ry@tinyclouds.org.

Soumission d'une pull request

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

  1. Donnez au PR un titre descriptif.

Exemples de bons titres de PR :

  • fix(std/http): Fix race condition in server
  • docs(console): Update docstrings
  • feat(doc): Handle nested re-exports

Exemples de mauvais titres de PR :

  • fix #7123
  • update docs

  • fix bugs

  • Ensure there is a related issue and it is referenced in the PR text.

  • Ensure there are tests that cover the changes.

Soumettre une PR à Capgo

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

  1. npm run lint réussit - cela vérifiera le code Rust et JavaScript pour détecter les erreurs et les fautes courantes 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 directement dans le code. Cela aide à garantir que le code et la documentation sont étroitement liés.

JavaScript et TypeScript

Toutes les API et types exposés publiquement, le module capacitor-updater devrait avoir une documentation JSDoc. Cette documentation est analysée et disponible pour le compilateur TypeScript, et donc facile à fournir en aval. Les blocs JSDoc se trouvent juste avant la déclaration à laquelle ils s'appliquent et sont indiqués par un /** initial avant de se terminer par un */. Par exemple :

export const FOO = "foo";

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