__CAPGO_KEEP_0__ Logo
Capgo home

Wir begrüßen und schätzen alle Beiträge zu Capgo.

Diese Seite dient als Hilfsmittel, um Sie bei der Anfertigung von Beiträgen zu unterstützen.

Projekte

Es gibt zahlreiche Repositories in der Organisation, die Teil des __CAPGO_KEEP_0__-Ökosystems sind. Capgo organization that are part of the Capgo ecosystem.

Um Ihnen dabei zu helfen, zu entscheiden, welches Repository am besten geeignet ist, um zu beginnen, zu kontribuieren (und/oder in Ihr Interesse fällt), hier ist eine kurze Vergleichsübersicht (<strong> Programmiersprachen in **Fett** umfassen den größten Teil des Codebases </strong>):

Dies ist das Haupt-Repository, das den Capgo

capacitor-updater

Plugin capacitor-updater bietet.

Sie möchten einen Fehler beheben oder ein neues Feature hinzufügen? capacitor-updaterDies ist das Repository, an dem Sie kontribuieren möchten.

Sprachen: **Swift**, **JavaScript**, Java

capgo

Die Webanwendung und die serverlosen Funktionen, die die Capgo-Cloud-Plattform ausmachen.

Teilen Sie, wo Sie beitragen möchten, um den Backend des Capgo zu reparieren.

Sprachen: TypeScript.

website

Vorderseite für offizielle Deno-Seite: https://capgo.app/

Sprachen: TypeScript, HTML, CSS

docs

Dokumentation in Markdown, die https://docs.capgo.app

Sprachen: Markdown

capacitor-standard-version

Ein Version Manager, der CI/CD ermöglicht, Apps zu aktualisieren.

Sprachen: JavaScript

  • Lesen Sie die style guide.

  • Stellen Sie in der Community-Chatt

  • eine Frage. Wenn Sie an einem Problem arbeiten, erwähnen Sie dies in den Kommentaren des Problems vorher, als Sie mit der Arbeit an dem Problem beginnen.

  • When Sie an einem neuen Feature arbeiten, erstellen Sie ein Issue und diskutieren Sie mit anderen Beiträgern. vorher Sie beginnen mit der Arbeit am Feature; wir schätzen alle Beiträge, aber nicht alle vorgeschlagenen Features werden akzeptiert. Wir möchten nicht, dass Sie Stunden damit verbringen, an einem code zu arbeiten, das möglicherweise nicht akzeptiert wird.

  • Bleiben Sie professionell in den Foren. Wir folgen Rust's code des Verhaltenskodex (CoC). Haben Sie ein Problem? Senden Sie eine E-Mail an ry@tinyclouds.org.

Ein Pull-Request einreichen

Bevor Sie einen PR an einem der Repos einreichen, stellen Sie bitte sicher, dass Folgendes getan ist:

  1. Geben Sie dem PR einen beschreibenden Titel.

Beispiele für gute PR-Titel:

  • fix(std/http): Beheben Sie den Rennbahnbedingung im Server
  • docs(console): Aktualisieren Sie die Dokumentationszeilen
  • feat(doc): Behandeln Sie verschachtelte Re-Exporte

Beispiele für schlechte PR-Titel:

  • fix #7123
  • aktualisieren Sie die Dokumentation

  • Beheben von Fehlern

  • Stellen Sie sicher, dass es ein damit zusammenhängendes Issue gibt und dass es in der PR-Text referenziert wird.

  • Stellen Sie sicher, dass es Tests gibt, die die Änderungen abdecken.

Ein PR bei Capgo

Zusätzlich zu den oben genannten stellen Sie sicher, dass:

  1. bun run lint dies überprüft - dies wird die Rust- und JavaScript code-Dateien auf allgemeine Fehler und Fehler überprüfen. Swiftlint (für Swift) und eslint (für JavaScript und Java)

Dokumentation von APIs

Es ist wichtig, alle öffentlichen APIs zu dokumentieren und wir möchten das inline mit dem code. Dies hilft sicherzustellen, dass code und Dokumentation eng miteinander verbunden sind.

JavaScript und TypeScript

Alle öffentlich ausgelieferten APIs und Typen, der capacitor-updater Modul sollte JSDoc-Dokumentation haben. Diese Dokumentation wird ausgelesen und ist für den TypeScript-Compiler verfügbar und daher leicht weiter unten bereitzustellen. JSDoc-Blöcke kommen direkt vor der Aussage, auf die sie anwendbar sind, und werden durch ein /** vor dem */beendet. Zum Beispiel:

export const FOO = "foo";

Finden Sie mehr unter: https://jsdoc.app/