Capgo logo

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

Diese Seite dient als Hilfe, um Ihnen den Einstieg in die Mitarbeit zu erleichtern.

Projekte

Es gibt zahlreiche Repositorys in der Capgo-Organisation, die Teil von Capgo sind.

Repositories haben unterschiedliche Bereiche, verwenden unterschiedliche Programmiersprachen und weisen unterschiedliche Niveaus in Bezug auf Beiträge auf.

Um Ihnen bei der Entscheidung zu helfen, welches Repository am besten geeignet ist, um Beiträge zu leisten (und/oder in Ihr Interesse fällt), hier ist ein kurzer Vergleich ( die in Fettdruck dargestellten Sprachen machen den größten Teil des Codes aus ):

capacitor-updater

Dies ist das Haupt-Repository, das das capacitor-updater Plugin bereitstellt.

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

Languages: Swift, JavaScript, Java

capgo

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

Dort, wo Sie zur Behebung des Backends von Capgo beitragen möchten.

Languages: TypeScript.

website

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

Languages: TypeScript, HTML, CSS

docs

Dokumentation in Markdown, die antreibt https://doc.capgo.app

Languages: Markdown

capacitor-standard-version

Versionsverwalter, der CI/CD antreibt, um Apps zu aktualisieren.

Languages: JavaScript

  • Lese den Stilführer.

  • Fragen Sie in dem Community-Chatraum nach Hilfe.

  • Wenn du an einem Problem arbeitest, erwähne dies in den Kommentaren zum Problem bevor du mit der Arbeit an dem Problem beginnst.

  • Wenn Sie an einer neuen Funktion arbeiten, erstellen Sie ein Issue und diskutieren Sie mit anderen Mitwirkenden bevor Sie mit der Arbeit an der Funktion beginnen; wir schätzen alle Beiträge, aber nicht alle vorgeschlagenen Funktionen werden akzeptiert. Wir möchten nicht, dass Sie Stunden mit Code verbringen, der möglicherweise nicht akzeptiert wird.

  • Bitte seien Sie professionell in den Foren. Wir folgen Rusts Verhaltensregeln (CoC). Haben Sie ein Problem? Schreiben Sie eine E-Mail an ry@tinyclouds.org.

Einen Pull-Request einreichen

Bevor Sie einen PR zu einem der Repos einreichen, stellen Sie bitte sicher, dass Folgendes erledigt ist:

  1. Gib dem PR einen beschreibenden Titel.

Beispiele für einen guten PR-Titel:

  • fix(std/http): Fix race condition in server
  • docs(console): Update docstrings
  • feat(doc): Handle nested re-exports

Beispiele für schlechte PR-Titel:

  • fix #7123
  • update docs

  • fix bugs

  • Ensure there is a related issue and it is referenced in the PR text.

  • Ensure there are tests that cover the changes.

Ein PR an Capgo einreichen

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

  1. `npm run lint` besteht - dies überprüft Rust- und JavaScript-Code auf häufige Fehler und Probleme mit Hilfe von `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 dies inline mit dem Code tun. Dies hilft sicherzustellen, dass Code und Dokumentation eng miteinander verbunden sind.

JavaScript und TypeScript

Alle öffentlich zugänglichen APIs und Typen im Modul capacitor-updater sollten JSDoc-Dokumentation haben. Diese Dokumentation wird vom TypeScript-Compiler analysiert und ist daher leicht weiterzugeben. JSDoc-Blöcke stehen unmittelbar vor der Anweisung, auf die sie sich beziehen, und werden durch einen führenden /** gekennzeichnet, gefolgt von einem abschließenden */. Zum Beispiel:

export const FOO = "foo";

Mehr finden unter: https://jsdoc.app/