Zum Hauptinhalt springen
Capgo Logo

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

Diese Seite dient als Hilfsmittel, um Sie bei der Beitragsarbeit zu unterstützen.

Projekte

Es gibt zahlreiche Repositories in dem Capgo Unternehmen, die Teil des Capgo Ökosystems sind.

Repositories haben unterschiedliche Bereiche, verwenden unterschiedliche Programmiersprachen und haben unterschiedliche Ebenen bei der Beitragshöhe.

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

capacitor-updater

Dies ist das Hauptrepository, das den capacitor-updater Plugin bereitstellt.

Sie möchten einen Fehler beheben oder eine neue Funktion hinzufügen zu capacitor-updater? Dies ist das Repository, an dem Sie kontribuieren möchten.

Sprachen: Swift, JavaScript, Java

capgo

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

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

Sprachen: TypeScript.

website

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

Sprachen: TypeScript, HTML, CSS

docs

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

Sprachen: Markdown

capacitor-standard-version

Version Manager, der die CI/CD-Pipeline ermöglicht, Apps zu aktualisieren.

Sprachen: JavaScript

  • Lesen Sie die Stilrichtlinie.

  • Stellen Sie in der Community-Chatt eine Anfrage nach Hilfe.

  • Wenn Sie an einem Problem arbeiten, erwähnen Sie dies in den Kommentaren zum Problem vor Sie beginnen mit der Arbeit an dem Problem.

  • Wenn Sie an einer neuen Funktion arbeiten, erstellen Sie ein Problem und diskutieren Sie dies mit anderen Beiträgern vor Sie beginnen mit der Arbeit an der Funktion; wir schätzen alle Beiträge, aber nicht alle vorgeschlagenen Funktionen werden akzeptiert. Wir möchten nicht, dass Sie Stunden damit verbringen, an einem code zu arbeiten, das möglicherweise nicht akzeptiert wird.

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

Ein Pull-Antrag 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 von Rassenbedingungen im Server
  • docs(console): Aktualisieren Sie die Dokumentation
  • feat(doc): Behandeln Sie verschachtelte Exporte

Beispiele für schlechte PR-Titel:

  • fix #7123
  • Dokumente aktualisieren

  • Fehler beheben

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

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

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

APIs dokumentieren

It ist wichtig, alle öffentlichen APIs zu dokumentieren und wir möchten das inline mit der 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 zur Verfügung zu stellen. JSDoc-Blöcke kommen direkt vor der Aussage, auf die sie anwendbar sind, und werden durch ein /** vor der Beendigung mit einem */. Zum Beispiel:

export const FOO = "foo";

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