Saltare al contenuto principale
Capgo logo

Benvenuti e ringraziamo per tutte le vostre contribuzioni a Capgo.

Questa pagina serve da aiuto per iniziare a contribuire.

Progetti

Ci sono numerosi repository all'interno dell'organizzazione che fanno parte dell'ecosistema di __CAPGO_KEEP_0__. Capgo organization that are part of the Capgo ecosystem.

Per aiutarvi a decidere quale repository potrebbe essere il migliore per iniziare a contribuire (e/o corrisponde ai vostri interessi), ecco una breve comparazione (<strong> i linguaggi in grassetto comprendono la maggior parte del codice </strong>):

Questo è il repository principale che fornisce Capgo

capacitor-updater

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

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

Lingue: Swift, JavaScript, Java

capgo

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

Condividi dove vuoi contribuire per risolvere il backend di Capgo.

Lingue: TypeScript.

website

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

Lingue: TipoScript, HTML, CSS

docs

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

Lingue: Markdown

capacitor-standard-version

Gestore di versione che alimenta CI/CD per aggiornare le app.

Lingue: JavaScript

  • Leggi il linee guida dello stile.

  • Chiedi aiuto nella stanza di chat della comunità.

  • Quando lavori su un problema, menziona ciò nei commenti del problema prima di iniziare a lavorare sul problema.

  • Quando lavori su una nuova funzionalità, crea un problema e discuti con gli altri contributori prima di iniziare a lavorare sulla funzionalità; apprezziamo tutte le contribuzioni, ma non tutte le funzionalità proposte vengono accettate. Non vogliamo che tu passi ore a lavorare su una code che potrebbe non essere accettata.

  • Per favore, sii professionale nei forum. Seguiamo Rust's code of conduct (CoC). Hai un problema? Invia un'email contattare ryan@tinyclouds.org.

Invia una richiesta di pull

Prima di inviare una PR a qualsiasi dei repository, assicurati di aver fatto quanto segue:

  1. Dai al PR un titolo descrittivo.

Esempi di titoli di PR buoni:

  • fix(std/http): Risolvi la condizione di corsa nel server
  • docs(console): Aggiorna le stringhe di documentazione
  • feat(doc): Gestisci le esportazioni nidificate

Esempi di titoli di PR cattivi:

  • fix #7123
  • aggiorna i documenti

  • risolvi i bug

  • Assicurarsi che ci sia un problema correlato e che sia menzionato nel testo della PR.

  • Assicurarsi che ci siano test che coprono le modifiche.

Invio di una PR a Capgo

Inoltre, oltre a quanto sopra, assicurarsi che:

  1. bun run lint passa - ciò verificherà il Rust e il JavaScript code per errori comuni e errori utilizzando Swiftlint (per Swift) e eslint (per JavaScript e Java)

Documentazione delle API

E' importante documentare tutte le API pubbliche e vogliamo farlo inline con il code. Ciò aiuta a garantire che code e la documentazione siano strettamente legati.

JavaScript e TypeScript

Tutte le API e i tipi esposti pubblicamente, il capacitor-updater modulo dovrebbe avere documentazione JSDoc. Questa documentazione viene analizzata e è disponibile al compilatore TypeScript, e quindi facile da fornire in seguito. I blocchi JSDoc vengono prima della dichiarazione a cui si applicano e sono denotati da un trattino orizzontale /** prima di interrompere con un */. Ad esempio:

export const FOO = "foo";

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