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 Capgo Capgo-Ökosystem.

Repositorien haben unterschiedliche Bereiche, verwenden verschiedene Programmiersprachen und haben unterschiedliche Ebenen, wenn es um Beiträge geht.

Um Ihnen dabei zu helfen, zu entscheiden, welches Repository am besten geeignet ist, um zu beginnen (und/oder in Ihren Interessen liegt), hier ist eine kurze Vergleichsübersicht (die **Sprachen** in Fettschrift umfassen den größten Teil des Codebases): Capgo

capacitor-updater

Dies ist der Haupt-Repository, das den capacitor-updater Capacitor-Updater-Plugin bereitstellt.

Plugin. capacitor-updaterSie möchten einen Fehler beheben oder eine neue Funktion zum

Capacitor-Updater hinzufügen. Dies ist das Repository, das Sie beitragen möchten. Schwetzen, JavaScript, Java

capgo

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

Kontaktiere uns, um zu sehen, wo du beitragen möchtest, um den Backend von Capgo zu reparieren.

Sprachen: TypeScript.

website

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

Sprachen: TypeScript, HTML, CSS

docs

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

Sprachen: Markdown

capacitor-standard-version

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

Sprachen: JavaScript

  • Lesen Sie die Stilrichtlinie.

  • Stellen Sie in der Gemeinschafts-Chatt

  • fragen Sie nach Hilfe. 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 eine Angelegenheit 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 PR-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 PR-Titel:

  • fix #7123
  • aktualisieren Sie die Dokumentation

  • fix Bugs

  • Stellen Sie sicher, dass es ein damit zusammenhängendes Problem gibt und es in der PR-Textreferenz ist.

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

Ein PR an Capgo einreichen zu Capgo

Zusätzlich zu den oben genannten sicherzustellen, dass:

  1. bun run lint Überprüft - dies wird die Rust- und JavaScript code-Dateien auf häufige 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 tun. Dies hilft sicherzustellen, dass code und Dokumentation eng miteinander verbunden sind.

JavaScript und TypeScript

Alle öffentlich zugänglichen APIs und Typen, die capacitor-updater Der 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 führendes /** vor dem Beenden mit einem */. Zum Beispiel:

export const FOO = "foo";

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