Zum Hauptinhalt springen

Wir freuen uns über alle Beiträge zu Capgo.

Diese Seite hilft dir dabei, mit deinen ersten Beiträgen zu starten.

Projekte

Es gibt zahlreiche Repositories in der Capgo Organisationen, die Teil des Capgo Ökosystems sind.

Repositories haben unterschiedliche Scopes, nutzen verschiedene Programmiersprachen und bieten verschiedene Möglichkeiten für Contributions.

Um dir bei der Entscheidung zu helfen, welches Repository am besten für deinen Einstieg geeignet ist, findest du hier einen kurzen Vergleich (<strong>Sprachen in Fettdruck machen den Großteil der Codebase aus</strong>): Capgo

capacitor-updater

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

Du möchtest einen Bug fixen oder ein neues Feature für capacitor-updater? Das ist das Repository, zu dem du beitragen möchtest.

Sprachen: Swift, JavaScript, Java

capgo

Die Webapp und Serverless Functions, aus denen die Capgo Cloud-Plattform besteht.

Sag uns, wo du beim Reparieren des Backends von Capgo mithelfen möchtest.

Sprachen: TypeScript.

website

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

Sprachen: TypeScript, HTML, CSS

docs

Markdown-Dokumentation für https://docs.capgo.app

Sprachen: Markdown

capacitor-standard-version

Version-Manager, der CI/CD für App-Updates antreibt.

Sprachen: JavaScript

  • Lies die Styleguide.

  • Hol dir Hilfe im Community-Chat.

  • Wenn du an einem Issue arbeitest, erwähne das bitte in den Issue-Kommentaren, bevor bevor du mit der Arbeit am Issue beginnst.

  • Wenn du an einem neuen Feature arbeitest, erstelle ein Issue und diskutiere es mit anderen Contributoren. bevor du fängst an, an einem Feature zu arbeiten; wir schätzen jeden Beitrag, aber nicht alle vorgeschlagenen Features werden akzeptiert. Wir möchten nicht, dass du Stunden in ein code investierst, das am Ende vielleicht nicht angenommen wird.

  • Bitte verhalte dich in den Foren professionell. Wir folgen code von Rust (Code of Conduct) (CoC). Probleme? Schreib uns eine E-Mail ry@tinyclouds.org.

Einen Pull Request einreichen

Bevor du einen PR in eines der Repos einreichst, stelle bitte sicher, dass Folgendes erledigt ist:

  1. Vergib einen aussagekräftigen Titel für den PR.

Beispiele für gute PR-Titel:

  • fix(std/http): Race Condition im Server beheben
  • docs(console): Docstrings aktualisieren
  • feat(doc): Verschachtelte Re-Exports behandeln

Beispiele für schlechte PR-Titel:

  • behebt #7123
  • Docs aktualisieren

  • Bugs fixen

  • Stelle sicher, dass ein zugehöriges Issue existiert und im PR-Text referenziert wird.

  • Stelle sicher, dass Tests die Änderungen abdecken.

Einen PR einreichen bei Capgo

Zusätzlich zu den obigen Punkten stelle sicher, dass:

  1. bun run lint besteht – dies prüft Rust und JavaScript code auf häufige Fehler und Probleme mittels Swiftlint (für Swift) und eslint (für JavaScript und Java)

APIs dokumentieren

Es ist wichtig, alle öffentlichen APIs zu dokumentieren, und wir möchten dies direkt im code tun. So stellen wir sicher, dass code und die Dokumentation eng miteinander verknüpft sind.

JavaScript und TypeScript

Alle öffentlich zugänglichen APIs und Typen, das capacitor-updater Modul sollten JSDoc-Dokumentationen enthalten. Diese Dokumentation wird geparst und ist für den TypeScript-Compiler verfügbar, was die Weitergabe nachgelagerter Informationen erleichtert. JSDoc-Blöcke stehen unmittelbar vor der entsprechenden Anweisung und werden durch ein vorangestelltes /** bevor sie mit einem abschließen, */. Zum Beispiel:

export const FOO = "foo";

Mehr dazu unter: Weitere Informationen unter https://jsdoc.app/