Zum Hauptinhalt springen
Capgo Logo

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

Dieses Seiten dient als Hilfestellung, um Ihnen bei der Beitragsarbeit zu helfen.

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> die Programmiersprachen in Fettschrift 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:

Sprachen: Schwartz, JavaScript, Java

capgo

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

Kontaktiere uns, um zu sehen, wo du beitragen möchtest, um den Backend des 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 den https://docs.capgo.app

Sprachen: Markdown

capacitor-standard-version

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

Sprachen: JavaScript

  • Die Stilrichtlinie lesen.

  • Bei Bedarf kann man sich im Community-Chatraum

  • fragen. Wenn man an einem Issue arbeitet, erwähne dies in den Issue-Kommentaren. 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. Gegeben Sie dem PR einen beschreibenden Titel.

Beispiele für gute PR-Titel:

  • fix(std/http): Rassenbedingung in Server beheben
  • docs(console): Aktualisieren Sie die Dokumentation
  • feat(doc): Verarbeiten Sie verschachtelte Exporte

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 dass es in der PR-Textreferenz ist.

  • 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ü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 der code tun. Dies hilft sicherzustellen, dass code und Dokumentation eng miteinander verbunden sind.

JavaScript und TypeScript

Alle öffentlich ausgelösten APIs und Typen, der 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 zur Verfügung gestellt werden. JSDoc-Blöcke kommen direkt vor der Aussage, auf die sie anwendbar sind, und werden durch einen führenden /** vor dem Beenden mit einem */. Zum Beispiel:

export const FOO = "foo";

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