Salta al contenuto principale

Tutti i contributi a Capgo sono benvenuti e apprezzati.

Questa pagina è pensata per aiutarti a iniziare a contribuire.

Progetti

Ci sono numerosi repository nell' Capgo organizzazioni che fanno parte dell'ecosistema Capgo.

I repository hanno scope diversi, usano linguaggi di programmazione differenti e richiedono diversi livelli di competenza per contribuire.

Per aiutarti a decidere quale repository sia il migliore per iniziare a contribuire (o che più ti interessa), ecco un breve confronto (<strong>i linguaggi in grassetto costituiscono la maggior parte del codebase</strong>): Capgo

capacitor-updater

Questo è il repository principale che fornisce il capacitor-updater Plugin.

Vuoi correggere un bug o aggiungere una nuova feature a capacitor-updater? Questo è il repository a cui vuoi contribuire.

Linguaggi: Swift, JavaScript, Java

capgo

La Webapp e le serverless functions che compongono la piattaforma cloud Capgo.

Dicci dove preferisci contribuire per sistemare il backend di Capgo.

Linguaggi: TypeScript.

website

Frontend per la pagina ufficiale di Deno: https://capgo.app/

Linguaggi: TypeScript, HTML, CSS

docs

Documentazione in Markdown che alimenta https://docs.capgo.app

Linguaggi: Markdown

capacitor-standard-version

Un version manager che potenzia la CI/CD per aggiornare le app.

Linguaggi: JavaScript

  • Leggi la guida di stile.

  • Chiedi aiuto nella chat della community.

  • Quando lavori a una issue, segnalalo nei commenti della issue prima prima di iniziare a lavorarci.

  • Quando lavori a una nuova feature, apri una issue e discutine con gli altri contributor prima inizi a lavorare su una feature; apprezziamo tutti i contributi, ma non tutte le proposte vengono accettate. Non vogliamo che passi ore a lavorare su una code che potrebbe non essere accettata.

  • Sii professionale nei forum. Seguiamo il code di condotta di Rust (CoC). Hai un problema? Scrivi a ry@tinyclouds.org.

Inviare una pull request

Prima di inviare una PR in uno dei repo, assicurati di aver completato quanto segue:

  1. Dai alla PR un titolo descrittivo.

Esempi di buoni titoli per le PR:

  • fix(std/http): correzione race condition nel server
  • docs(console): Aggiorna docstrings
  • feat(doc): Gestione dei re-export annidati

Esempi di titoli PR errati:

  • fix #7123
  • update docs

  • correggi bug

  • Assicurati che ci sia un'issue correlata e che sia citata nel testo della PR.

  • Assicurati che ci siano dei test che coprano le modifiche.

Inviare una PR a Capgo

Oltre a quanto sopra, assicurati che:

  1. bun run lint passi - questo controllerà il code di Rust e JavaScript per errori comuni usando Swiftlint (per Swift) e eslint (per JavaScript e Java)

Documentare le API

È fondamentale documentare tutte le API pubbliche e vogliamo farlo in linea con code. Questo assicura che code e la documentazione siano strettamente accoppiati.

JavaScript e TypeScript

Tutte le API e i tipi esposti pubblicamente, il capacitor-updater modulo dovrebbero avere la documentazione JSDoc. Questa viene analizzata dal compilatore TypeScript, facilitandone l'uso a valle. I blocchi JSDoc precedono l'istruzione a cui si riferiscono e sono indicati da un /** prima di terminare con un */. Per esempio:

export const FOO = "foo";

Scopri di più su: Scopri di più su https://jsdoc.app/