Saltare al contenuto principale

Siamo grati a tutti coloro che contribuiscono a Capgo.

Questa pagina serve da aiuto per iniziare a contribuire.

Progetti

Ci sono numerosi repository nel Capgo organizzazione che fanno parte dell'ecosistema Capgo.

I repository hanno diversi ambiti, utilizzano linguaggi di programmazione diversi e hanno livelli di contribuzione variabile.

To help you decide which repository might be the best to start contributing (and/or falls into your interest), here is a short comparison (<strong> languages in bold comprise most of the codebase </strong>): Capgo

capacitor-updater

This is the main repository that provides the capacitor-updater Contribuisci

Vuoi risolvere un bug o aggiungere una nuova funzionalità a capacitor-updaterVuoi contribuire a questo repository.

Idiomi: Swift, JavaScript, Java

capgo

Condividi dove vuoi contribuire per risolvere il backend di Capgo.

Condividi dove vuoi contribuire per risolvere il backend di Capgo.

Idiomi: TypeScript.

website

https://__CAPGO_KEEP_0__.app/ https://capgo.app/

Lingue: TypeScriptHTML, CSS

docs

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

Lingue: Markdown

capacitor-standard-version

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

Lingue: JavaScript

  • Leggi il guida allo stile.

  • Chiedi aiuto nella room di discussione della comunità.

  • Quando lavori su un problema, menziona questo nella sezione dei 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 prima di iniziare a lavorare sulla funzionalità; apprezziamo tutte le contribuzioni, ma non tutte le funzionalità proposte vengono accettate. Non vogliamo che tu spenda ore a lavorare su un code che potrebbe non essere accettato.

  • Per favore, sii professionale nei forum. Seguiamo Rust's code of conduct (CoC). Hai un problema? Invia un'email a perfavore_sii_professionale_nelle_forum

Invia una richiesta di pull

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

  1. Dai alla PR un titolo descrittivo.

Esempi di titoli di PR buoni:

  • Correggi (std/http): Correggi la condizione di corsa nel server
  • aggiorna le stringhe di documentazione
  • Aggiungi (doc): Gestisci le esportazioni nidificate

Esempi di titoli di PR cattivi:

  • Correggi #7123
  • Aggiorna documenti

  • Correggi i bug

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

  • Eseguire test che coprano le modifiche.

Invia una PR a Capgo

Ecco alcune linee guida per contribuire a Capgo:

  1. bun run lint Esegui le verifiche - questo controllerà Rust e JavaScript code per errori e problemi comuni utilizzando Swiftlint (per Swift) e eslint (per JavaScript e Java)

Documentazione 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 inseriti prima della dichiarazione a cui si applicano e sono denotati da una riga /** precedente che termina con un */Per esempio:

export const FOO = "foo";

Ecco dove trovare di più: https://jsdoc.app/