Zum Hauptinhalt springen

Wir freuen uns und schätzen alle Beiträge zu Capgo.

Diese Seite dient als Hilfestellung, um Ihnen bei der Beitragsarbeit zu beginnen.

Projekte

Es gibt zahlreiche Repositories im Capgo organization that are part of the Capgo ecosystem.

Die Repositories haben unterschiedliche Bereiche, verwenden unterschiedliche Programmiersprachen und haben unterschiedliche Ebenen bei der Beitragshöhe.

Um Ihnen zu helfen, zu entscheiden, welches Repository am besten geeignet ist, um zu beginnen, zu kontribuieren (und/oder in Ihr Interesse fällt), hier ist eine kurze Vergleichsliste (<strong>die Sprachen in Fettschrift umfassen den größten Teil des Codebases</strong>): Capgo

capacitor-updater

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

Sie möchten einen Fehler beheben oder ein neues Feature zu capacitor-updater? Dies ist das Repository, an dem Sie beitragen möchten.

Sprachen: Swift, JavaScript, Java

capgo

Teilen Sie mit, wo Sie beitragen möchten, um den Backend von Capgo zu reparieren.

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

Sprachen: TypeScript.

website

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

Sprachen: TypeScriptHTML, CSS

docs

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

Sprachen: Markdown

capacitor-standard-version

Versionsmanager, der CI/CD zur Aktualisierung von Apps ermöglicht.

Sprachen: JavaScript

  • Lesen Sie das Stilhandbuch.

  • Bitten Sie um Hilfe im Gemeinschaftschatzimmer.

  • Wenn Sie an einem Problem arbeiten, erwähnen Sie dies in den Kommentaren zum Problem. before Sie beginnen mit der Bearbeitung des Problems.

  • Beachten Sie, dass Sie vorher in den Kommentaren des Issues erwähnen, wenn Sie an einem Issue arbeiten. before you start working on the feature; we appreciate all contributions, but not all proposed features are getting accepted. We don't want you to spend hours working on a code that might not be accepted.

  • Bitte seien Sie in den Foren professionell. Wir folgen Rusts code von Verhaltenskodex (CoC). Haben Sie ein Problem? E-Mail kontakt@tinyclouds.org.

Ein Pull-Request einreichen

Bevor Sie einen PR an einen der Repositories 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 Re-Exports

Beispiele für schlechte PR-Titel:

  • fix #7123
  • update docs

  • fixen Sie Fehler

  • Stellen Sie sicher, dass es ein damit zusammenhängendes Problem gibt und es im PR-Text erwähnt wird.

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

Ein Pull-Request an Capgo einreichen Capgo

Zusätzlich dazu stellen Sie sicher, dass:

  1. bun run lint passes - this will check Rust and JavaScript code for common mistakes and errors using Swiftlint (für Swift) und eslint (für JavaScript und Java)

Dokumentation von APIs

It is important to document all public APIs and we want to do that inline with the code. This helps ensure that code and documentation are tightly coupled together.

JavaScript und TypeScript

Alle öffentlich zugänglichen APIs und -Typen sowie die capacitor-updater Modul sollte JSDoc-Dokumentation haben. Diese Dokumentation wird analysiert und ist für den TypeScript-Compiler verfügbar, sodass es leicht ist, weitere Informationen bereitzustellen. JSDoc-Blöcke kommen direkt vor der Aussage, auf die sie sich beziehen, und werden durch eine führende /** vor dem Ende mit einem */. Zum Beispiel:

export const FOO = "foo";

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