Saltare al contenuto principale
Capgo logo

Benvenuti e siamo grati a tutti i contributi a Capgo.

Questa pagina serve come aiuto per iniziare a contribuire.

Progetti

C'è un gran numero di repository all'interno dell'organizzazione che fanno parte dell'ecosistema di __CAPGO_KEEP_0__. Capgo organization that are part of the Capgo ecosystem.

Per aiutarti a decidere quale repository potrebbe essere il migliore da cui iniziare a contribuire (e/o che rientra nei tuoi interessi), ecco una breve comparazione (<strong> i linguaggi in grassetto comprendono la maggior parte del codicebase </strong>):

Questa è la repository principale che fornisce il Capgo

capacitor-updater

Plugin. capacitor-updater Vuoi risolvere un bug o aggiungere una nuova funzionalità a

? Questa è la repository a cui vuoi contribuire. capacitor-updaterLingue:

Contribuisci Swift, JavaScript, Java

capgo

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

Condividi dove vuoi contribuire per risolvere il backend di Capgo.

Idiomi: TypeScript.

website

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

Idiomi: TypeScript, HTML, CSS

docs

La documentazione in Markdown che alimenta https://docs.capgo.app

Idiomi: Markdown

capacitor-standard-version

Il gestore di versione che alimenta la CI/CD per aggiornare le app.

Idiomi: JavaScript

  • Leggi il style guide.

  • Chiedi aiuto nella community chat room.

  • Quando lavori su un problema, menziona questo nella sezione dei commenti del problema. prima iniziare a lavorare sull'issue

  • Quando lavorate su una nuova funzione, create un issue e discutete con gli altri contributori prima iniziare a lavorare sulla funzione; apprezziamo tutti i contributi, ma non tutti i feature proposti vengono accettati. Non vogliamo che spendiate ore a lavorare su un code che potrebbe non essere accettato.

  • Per favore, siete professionali nei forum. Seguiamo Rust's code of conduct (CoC). Avete un problema? Email ry@tinyclouds.org.

Invio di una richiesta di pull

Prima di inviare una PR a qualsiasi dei repos, per favore assicuratevi che sia stato fatto il seguente:

  1. Dategli un titolo descrittivo.

Esempi di titolo di buona PR:

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

Esempi di titolo di cattiva PR:

  • fix #7123
  • aggiorna i documenti

  • risolvi i bug

  • Assicurati di avere un problema correlato e che sia menzionato nel testo della PR.

  • Assicurati di avere dei test che coprono le modifiche.

Invia una PR a Capgo

Aggiungere inoltre a quanto sopra assicurati di:

  1. bun run lint Esegui - questo controlla Rust e JavaScript code per errori e errori comuni utilizzando Swiftlint Esegui (per Swift) e eslint Esegui (per JavaScript e Java) e

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 pubblicamente esposti, il capacitor-updater modulo dovrebbe avere documentazione JSDoc. Questa documentazione viene analizzata e resa disponibile al compilatore TypeScript, e quindi facile da fornire in seguito. I blocchi JSDoc vengono forniti prima della dichiarazione a cui si applicano e sono denotati da un /** preceduto da un */. Ad esempio:

export const FOO = "foo";

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