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 Repositorien 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 beitragen (und/oder in Ihrem Interesse liegt), finden Sie hier eine kurze Vergleichsübersicht (<strong> Programmiersprachen in **Fett** umschlossen, umfassen den größten Teil des Codebases </strong>):

Dies ist das Hauptrepositorium, das den Capgo

capacitor-updater

Plugin capacitor-updater bietet.

Sie möchten einen Fehler beheben oder ein neues Feature hinzufügen zu capacitor-updater? Dies ist das Repository, an dem Sie beitragen 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-Webseite: https://capgo.app/

Sprachen: TypeScript, HTML, CSS

docs

Dokumentation in Markdown, die die Funktionalität ermöglicht https://docs.capgo.app

Sprachen: Markdown

capacitor-standard-version

Versionmanager, der die CI/CD-Infrastruktur zur Aktualisierung von Apps ansteuert.

Sprachen: JavaScript

  • Lesen Sie die Stilrichtlinie.

  • Stellen Sie in der Community-Chatt

  • Wenn Sie an einem Problem arbeiten, erwähnen Sie dies in den Kommentaren zur Issue. vorher bevor Sie mit der Bearbeitung des Problems beginnen.

  • Wenn Sie an einem neuen Feature arbeiten, erstellen Sie ein Issue und diskutieren Sie mit anderen Beiträgern vorher bevor Sie an dem Feature arbeiten; 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.

  • Bitte seien Sie professionell in den Foren. Wir folgen Rust's code des Verhaltenskodex (CoC). Haben Sie ein Problem? E-Mail 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): Rassenbedingung in Server reparieren
  • docs(console): Aktualisieren Sie die Dokumentation
  • feat(doc): Verarbeiten Sie verschachtelte Exporte

Beispiele für schlechte PR-Titel:

  • fix #7123
  • Dokumentation 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 bei Capgo

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

  1. bun run lint Ü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 der code. Dies hilft sicherzustellen, dass code und Dokumentation eng miteinander verbunden sind.

JavaScript und TypeScript

Alle öffentlich ausgelösten APIs und Typen, die capacitor-updater Modul sollte JSDoc-Dokumentation haben. Diese Dokumentation wird ausgelesen und ist dem TypeScript-Compiler zur Verfügung gestellt, und daher leicht weiter unten bereitzustellen. JSDoc-Blöcke kommen direkt vor der Aussage, auf die sie anwendbar sind, und werden durch eine führende /** bis zum Ende mit einer */Beispiel:

export const FOO = "foo";

Finden Sie mehr unter: https://jsdoc.app/ Find more at: https://jsdoc.app/