Zum Hauptinhalt springen
Capgo Logo

We welcome and appreciate all contributions to Capgo.

Dieses Dokument dient als Hilfsmittel, um Ihnen bei der Beitragsarbeit zu helfen.

Projekte

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

Um Ihnen dabei zu helfen, zu entscheiden, welcher Repository am besten geeignet ist, um zu beginnen (und/oder in Ihren Interessen liegt), finden Sie hier eine kurze Übersicht (<strong> die in **fett** dargestellten Sprachen 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 zu Capacitor Updater hinzufügen möchten, ist dies der Repository, an dem Sie beitragen möchten.

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

Sprachen: Swift, JavaScript, Java

capgo

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

Share where you want to contribute to fix the backend of Capgo.

Share, wo Sie beitragen möchten, um den Backend von __CAPGO_KEEP_0__ zu reparieren. Sprachen:.

website

TypeScript https://capgo.app/

https://__CAPGO_KEEP_0__.app/ TypeScript, HTML, CSS

docs

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

https://docs.__CAPGO_KEEP_0__.app Sprachen:

capacitor-standard-version

Markdown

Eine Versionsverwaltung, die die CI/CD-Systeme zur Aktualisierung von Apps ansteuert. context: Page/area: Capgo marketing website. Role: Website copy sentence. Seen in: page contributing.astro. Message key `version_manager_that_power_ci_cd_to_update_apps` (Version Manager That Power Ci Cd To Update Apps).

  • Sprachen: JavaScript

  • Lesen Sie die Anleitung zum Stilguide für Capgo-Entwickler. Kommunikationsraum der Gemeinschaft.

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

  • Wenn Sie an einem neuen Feature arbeiten, erstellen Sie ein Problem und diskutieren Sie es 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 um. Wir folgen Rusts code der Verhaltensregeln (CoC). Haben Sie ein Problem? E-Mail ry@tinyclouds.org.

Ein Pull-Request einreichen

Bevor Sie einen Pull Request an einem der Repositories einreichen, stellen Sie sicher, dass Folgendes erledigt ist:

  1. Beschreiben Sie den Pull Request mit einem aussagekräftigen Titel.

Beispiele für gute Pull Request Titel:

  • fix(std/http): Beheben von Rassenbedingungen im Server
  • docs(console): Aktualisieren von Dokumentationszeilen
  • feat(doc): Behandeln von verschachtelten Re-Exporten

Beispiele für schlechte Pull Request Titel:

  • fix #7123
  • aktualisieren Sie die Dokumentation

  • fixen Sie Fehler

  • Stellen Sie sicher, dass es ein damit zusammenhängendes Issue gibt und dass es in der Pull Request-Textreferenziert wird.

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

Ein Pull-Request an Capgo

zusätzlich dazu sicherstellen, dass:

  1. bun run lint überprüft - dies überprüft Rust und JavaScript code auf alltägliche Fehler und Fehler mithilfe von Swiftlint (für Swift) und eslint (für JavaScript und Java)

Dokumentation von APIs

Wichtig ist es, 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 ausgeliefernten 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 führendes /** vor dem Beenden mit einem */. Zum Beispiel:

export const FOO = "foo";

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