Zum Hauptinhalt springen
Capgo Logo

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

Dieses Seiten 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 beginnen (und/oder in Ihren Interessen liegt), finden Sie hier eine kurze Übersicht (<strong> Sprachen in **Fett** umfassen den größten Teil des Codebases </strong>):

Dies ist der Haupt-Repository, das den Capgo

capacitor-updater

Plugin. capacitor-updater Sollten Sie einen Fehler beheben oder eine neue Funktion hinzufügen wollen zu

? Dies ist das Repository, an dem Sie beitragen möchten. capacitor-updaterSprachen:

Repositories haben unterschiedliche Bereiche, verwenden unterschiedliche Programmiersprachen und haben unterschiedliche Ebenen, wenn es um Beiträge geht. Schwifft, JavaScript, Java

capgo

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

Klicken Sie hier, um zu teilen, wo Sie beitragen möchten, um den Backend von Capgo zu reparieren.

Sprachen: TypeScript.

website

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

Sprachen: TypeScript, HTML, CSS

docs

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

Sprachen: Markdown

capacitor-standard-version

Versionen-Manager, der die CI/CD-Workflow zur Aktualisierung von Apps ansteuert.

Sprachen: JavaScript

  • Lesen Sie die style guide.

  • Stellen Sie in der Gemeinschafts-Chathaus

  • Wenn Sie an einem Issue arbeiten, erwähnen Sie dies in den Kommentaren zum Issue. vorher Sie beginnen mit der Arbeit an der Angelegenheit.

  • Wenn 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.

  • Bitten Sie in den Foren professionell. Wir folgen Rust's code von Verhaltensregeln (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. Beschreiben Sie den PR mit einem beschreibenden Titel.

Beispiele für gute Pull-Request-Titel:

  • fix(std/http): Rassenbedingung in Server beheben
  • docs(console): Aktualisieren Sie die Dokumentation
  • feat(doc): Behandeln Sie verschachtelte Re-Export

Beispiele für schlechte Pull-Request-Titel:

  • fix #7123
  • aktualisieren Sie die Dokumentation

  • fix Bugs

  • Stellen Sie sicher, dass es eine verwandte Issue gibt und dass sie in der PR-Text referenziert wird.

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

Ein Pull-Request bei Capgo

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

  1. bun run lint Überprüfen - dies wird die Rust- und JavaScript code 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 tun. 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 analysiert 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 führendes /** vor dem Beenden mit einem */. Zum Beispiel:

export const FOO = "foo";

Finde mehr unter: https://jsdoc.app/