Saltare al contenuto principale
Capgo logo

Siamo lieti di accogliere e apprezziamo tutte le contribuzioni a Capgo.

Questa pagina serve da aiuto per aiutarti a iniziare a contribuire.

Progetti

Ci sono numerosi repository all'interno dell'organizzazione che fanno parte dell'ecosistema __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 corrisponde ai tuoi interessi), ecco una breve comparazione (<strong> i linguaggi in grassetto comprendono la maggior parte del codice </strong>):

Questo è il repository principale che fornisce il Capgo

capacitor-updater

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

? Questo è il repository a cui vuoi contribuire. capacitor-updaterLingue:

__CAPGO_KEEP_0__ Swift, JavaScript, Java

capgo

The Webapp and serverless functions that make up the Capgo cloud platform.

Share where you want to contribute to fix the backend of Capgo.

Lingue: TypeScript.

website

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

Lingue: TypeScript, HTML, CSS

docs

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

Lingue: Markdown

capacitor-standard-version

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

Lingue: JavaScript

  • Leggi il style guide.

  • Chiedi aiuto nella community chat room.

  • Quando lavori su un problema, menziona così nelle commenti del problema. prima di iniziare a lavorare sull'issue. Quando lavori su una nuova funzionalità, crea un issue 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 __CAPGO_KEEP_0__ che potrebbe non essere accettato. you start working on the feature; we appreciate all contributions, but not all proposed features are getting accepted. We don't want you to spend hours working on a code that might not be accepted.

  • Rust's __CAPGO_KEEP_0__ di condotta Rust's code of conduct ry@tinyclouds.org. Invio di una richiesta di pull

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

Dai al PR un titolo descrittivo.

  1. Invio di una richiesta di pull prima di inviare una PR a qualsiasi repository, assicurati di aver fatto quanto segue: Dai al PR un titolo descrittivo.

Esempi di buone titoli 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 cattivi titoli PR:

  • fix #7123
  • aggiorna documentazione

  • risolvi bug

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

  • Assicurati che ci siano test che coprono le modifiche.

Invio di una PR a Capgo

Inoltre, oltre a quanto sopra, assicurati che:

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

Documentazione delle API

È 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 per il 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 /** prima di terminare con un */Esempio:

export const FOO = "foo";

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