Guida di Contribuzione al Plugin Capacitor

Capacitor i plugin connettono le tecnologie web con le funzionalità di dispositivo nativo, consentendo sviluppo di applicazioni cross-platformQuesto manuale ti aiuta:

• Configura il tuo ambiente: Strumenti come Node.js, Xcode, e Android Studio sono fondamentali.
• Segui le Code Linee Guida: Utilizza TypeScript, Swift, e Kotlin con convenzioni di denominazione e gestione degli errori coerenti.
• Testa Metodicamente: Scrivi test unitari per JavaScript, iOS e Android per garantire la affidabilità.
• Documenta Chiaramente: Utilizza JSDoc e file README per una facile adozione.
• Invia una Richiesta di Modifica: Assicurati di avere un alto livello di qualità per code, testing e documentazione prima di contribuire.

Guida Completa all'Open Source - Come Contribuire

Impostazione dell'ambiente di sviluppo

La configurazione dell'ambiente di sviluppo è fondamentale per lo sviluppo efficiente dei plugin. Una buona preparazione consente una codifica, una verifica e una distribuzione dei plugin fluidi.

Strumenti e competenze necessarie

Prima di iniziare, assicurati di avere gli strumenti seguenti installati:

Devi essere anche a tuo agio con TypeScript per lo sviluppo web e con Swift (per iOS) o Java/Kotlin (per Android) per le attività di sviluppo nativo [1][2].

Configurazione del Monorepo

La Capacitor plugin L'ecosistema si basa su una struttura di monorepo. Questo approccio garantisce che il tuo lavoro si allinei con le norme della community fin dall'inizio.

1. Fork e Clona il Repository
   Inizia forkando il repository delle Capacitor plugin su GitHub. Poi, clona il tuo repository forkato:

   git clone https://github.com/your-username/capacitor-plugins.git
   cd capacitor-plugins
   npm install

2. Installa Dipendenze e Costruisci
   Esegui il seguente comando per installare tutto ciò di cui hai bisogno e costruire i plugin:

   npm run build

3. Configura il Controllo di Versione
   Utilizza rami di feature per le tue modifiche e mantieni sincronizzato il tuo fork con il repository upstream.

Preparazione delle Piattaforme Native

Per lo sviluppo cross-platform, avrai bisogno di configurare sia l'ambiente iOS che Android.

Per iOS:

• Scarica Xcode dal Mac App Store.

• Installa gli strumenti di riga di comando utilizzando:

  xcode-select --install

• Installa CocoaPods con:

  sudo gem install cocoapods

• Configura un account di sviluppatore Apple e i certificati necessari.

• Utilizza SwiftLint (facoltativo) per mantenere la code qualità.

Per Android:

• Installa Android Studio insieme alla versione più recente SDK e una dispositivo virtuale.
• Assicurati di avere installato un JDK.
• Configura correttamente il SDK Android all'interno di Android Studio.

Una volta configurati questi piattaforme, sarai pronto a seguire le pratiche di codifica stabilite e immergerti nel sviluppo di plugin.

Code Standards Guide

Ora che il tuo ambiente di sviluppo è configurato, segui queste linee guida per creare plugin facili da mantenere e utilizzare.

Compliance dello stile Guida

La Capacitor ecosistema del plugin adotta rigorosi standard di codifica utilizzando strumenti come ESLint, Prettier, e SwiftLint. Ecco una panoramica rapida delle formattazioni richieste:

Plugins dovrebbero utilizzare TypeScript per una maggiore sicurezza dei tipi e le caratteristiche di ES6+ come async/awaitInoltre, segui le convenzioni di codifica specifiche per la piattaforma per Swift (iOS) e Kotlin (Android).

Gestione degli Errori e dei Tipi

Una gestione degli errori coerente è cruciale per la compatibilità cross-platform. Ecco un esempio:

async checkPermissions(): Promise<PermissionStatus> {
  try {
    const result = await this.implementation.checkPermissions();
    return result;
  } catch (error) {
    throw new Error(`Permission check failed: ${error.message}`);
  }
}

Per la sicurezza dei tipi:

• Utilizza interfacce focalizzate su casi d'uso specifici.
• Applica tipi di unione per variazioni specifiche della piattaforma.

Code Documentazione

Una buona documentazione è fondamentale per rendere il tuo plugin accessibile e facile da utilizzare. Segui queste pratiche:

1. API Documentazione: Scrivi commenti JSDoc che funzionano con @capacitor/docgenEcco un esempio:

/**
 * @description Get the device's current battery level
 * @returns Promise with the battery level percentage
 */
async getBatteryLevel(): Promise<{ level: number }>;

2. Struttura README: Includere informazioni essenziali come le istruzioni di installazione, le istruzioni di configurazione, le specifiche del sistema operativo, gli esempi di utilizzo e una dettagliata API documentazione di riferimento.

Una documentazione ben scritta assicura che il tuo plugin sia facile da adottare e contribuisce alla comunità Capacitor più ampia.

sbb-itb-f9944d2

Guida per la verifica dei plugin

La verifica dei plugin Capacitor consiste nell'attenzione a poche aree critiche per garantire una funzionalità liscia e affidabile.

Test delle ponti native

I test delle ponti native assicurano una comunicazione corretta tra JavaScript e code. Per iniziare, configurare l'ambiente di testing con framework adatti a ogni piattaforma.

Ecco un esempio di un Jest test di unità per il lato JavaScript:

// Example of a Jest unit test for the JavaScript bridge
describe('DeviceInfo Plugin', () => {
  test('getBatteryLevel returns valid percentage', async () => {
    const result = await DeviceInfo.getBatteryLevel();
    expect(result.level).toBeGreaterThanOrEqual(0);
    expect(result.level).toBeLessThanOrEqual(100);
  });
});

Per la verifica sul lato nativo, utilizzare XCTest per iOS e JUnit per Android. Ecco un esempio per Android:

@Test
fun testBatteryLevel() {
    val plugin = DeviceInfo()
    val result = plugin.getBatteryLevel()
    assertTrue(result.level in 0..100)
}

Una volta confermata la funzionalità della bridge di base, procedi con la verifica delle workflow complete degli utenti.

Test dei Plugin Completi

Per assicurarti che il tuo plugin funzioni bene in diversi scenari, testa le seguenti categorie:

Per i plugin con funzionalità complesse, simulare scenari realistici di utilizzo da parte degli utenti. Ad esempio, se stai testando un plugin DeviceInfo, controlla per:

• Caricamenti riusciti in diverse condizioni di rete
• Rapporto di avanzamento preciso
• Utilizzo della memoria durante i trasferimenti di file di grandi dimensioni

Test di OTA con Capgo

Le strumentazioni open-source di Capgo rendono facile l'implementazione e il test delle aggiornamenti in modo rapido. Ecco come utilizzarle:

1. Configurazione canali di aggiornamento come dev, staging e production
2. L'automazione dei deployment con strumenti CI/CD
3. L'invio di aggiornamenti istantaneo
4. Monitorare le prestazioni e i problemi tramite il Capgo dashboard.

Per i rilasci fasi, Capgo consente di limitare gli aggiornamenti a una piccola percentuale di utenti. Ad esempio, puoi rilasciare una nuova versione a 25% degli utenti ogni 24 ore:

// Example configuration for staged rollout
{
  "plugin": "camera-plugin",
  "version": "1.2.0",
  "rollout": {
    "percentage": 25,
    "interval": "24h"
  }
}

Questa approccio fasi aiuta a identificare i problemi in anticipo sfruttando i feedback della community prima di un rilascio completo.

Processo di Richiesta di Modifica

Una volta che hai testato a fondo le tue modifiche, segui questi passaggi per inviare la tua richiesta di modifica:

Elenco di Controllo per la Sottomissione

Prima di sottoporre, assicurati di aver coperto queste aree chiave:

Linee guida della community

Quando collabori, segui queste migliori pratiche:

• Rispondi velocemente alle feedback dei revisori.
• Tieni le discussioni focalizzate sui dettagli tecnici.
• Utilizza la funzione di proposta di GitHub per proporre code modifiche.
• Invia richieste di pull piccole e focalizzate che si occupano di una sola funzione o problema alla volta.

Per modifiche più grandi, è una buona idea creare un problema prima e discutere la tua approccio. Il team di Capacitor dipende dalle GitHub Actions per i controlli automatizzati, e tutti i controlli devono passare prima che la tua richiesta di pull possa essere valutata.

Guida di integrazione Capgo

Se il tuo plugin prevede aggiornamenti in tempo reale, assicurati che funzioni senza problemi con Capgo prima di inviarlo:

1. Controllo delle versioni
   Utilizza una versioning semantico chiaro per il tuo plugin e documenta tutte le modifiche nel changelog. Il sistema di Capgo aiuta a monitorare l'adozione delle versioni su dispositivi degli utenti.

2. Integrazione CI/CD
   Integra Capgo nella tua pipeline CI/CD per automatizzare i rilasci degli aggiornamenti.

3. Monitoraggio degli aggiornamenti
   Monitora i tassi di successo dei rilasci e assicurati di rispettare le linee guida degli store di app.

Riepilogo

Per fare una contribuzione significativa con il tuo plugin, è importante seguire il processo stabilito e rispettare gli standard della community. Ciò include l'osservanza delle linee guida di codifica di Capacitor e la verifica approfondita del tuo lavoro.

Il checklist PR evidenzia la necessità di invii di alta qualità. Se il tuo plugin supporta gli aggiornamenti in tempo reale, integrandolo con Capgo (come menzionato in precedenza) puoi rilasciare aggiornamenti velocemente senza dover attendere l'approvazione degli store di app.

Una volta che il tuo PR è stato integrato, rimani coinvolto seguendo le issue e rilasciando aggiornamenti di versione. L'interazione regolare con la community, la manutenzione costante e mantenere l'aggiornamento con le Capacitor aggiornamenti assicurerà che il tuo plugin rimanga utile e pertinente.

Prenditi cura delle recensioni degli utenti e aggiorna il tuo plugin quando necessario. Questo sforzo continuo aiuta a mantenere la qualità generale dell'ecosistema e mantiene il tuo plugin utile per i sviluppatori.

Continua da qui il Capacitor Guida alla Contribuzione dei Plugin

Se stai utilizzando la Capacitor Guida alla Contribuzione dei Plugin per pianificare il lavoro dei plugin nativi, connettilo con la Capgo Directory dei Plugin per il flusso di lavoro del prodotto nella Capgo Directory dei Plugin la Capacitor Plugins da Capgo per i dettagli di implementazione nella Capacitor Plugins da Capgo Aggiungere o Aggiornare i Plugin per i dettagli di implementazione in Aggiungere o Aggiornare Plugin, I Alternativi per Plugin Enterprise Ionic per il flusso di lavoro del prodotto in I Alternativi per Plugin Enterprise Ionic, e Capgo Costruzione Nativa per il flusso di lavoro del prodotto in Capgo Costruzione Nativa.