Guida alla Contribuzione del Plugin Capacitor

Capacitor i plugin connettono tecnologie web con funzionalità di dispositivo nativo, consentendo lo sviluppo di applicazioni cross-platform. Questa guida ti aiuterà:

• Configura il tuo ambiente: Strumenti come Node.js, Xcode, e Android Studio sono essenziali.
• Segui Code Standards: Utilizza TypeScript, Swift, e Kotlin con convenzioni di denominazione e gestione degli errori coerenti.
• Testa Accuratamente: 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: Ensure high-quality code, testing, and documentation before contributing.

Guida Completa per Open Source - Come Contribuire

Configurazione dell'ambiente di sviluppo

La configurazione dell'ambiente di sviluppo è fondamentale per lo sviluppo efficiente dei plugin. Un setup ben preparato consente una codifica, una prova e una distribuzione dei plugin fluidi.

Strumenti e competenze che avrai bisogno

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

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. Forka e Clona il Repository
   Inizia forkando il repository dei plugin Capacitor su GitHub. Poi, clona il tuo repository forkato:

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

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

   npm run build

3. Configurare il Controllo delle Versioni
   Usa rami di feature per le tue modifiche e mantieni sincronizzato il tuo fork con il repository upstream.

Preparare le 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 con:

  xcode-select --install

• Installa CocoaPods con:

  sudo gem install cocoapods

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

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

Per Android:

• Installa Android Studio insieme alla versione più recente di 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 a immergerti nello sviluppo di plugin.

Linee guida per lo sviluppo di plugin Code

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

Compliance alla Guida dello stile

La Ecosistema dei plugin Capacitor utilizza strumenti come ESLint, Prettier, e SwiftLint. Ecco una panoramica rapida delle formattazioni richieste:

Il plugin dovrebbe utilizzare TypeScript per una maggiore sicurezza dei tipi e le funzionalità ES6+ come async/await. Inoltre, segui le convenzioni di codifica specifiche 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 delle piattaforme.

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/docgen. Ad esempio:

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

2. README Struttura: Includi informazioni essenziali come le istruzioni di installazione, le istruzioni di configurazione, le richieste specifiche per piattaforma, gli esempi di utilizzo e una dettagliata API reference.

La 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 Bridge Native

Il testing delle bridge native assicura una comunicazione corretta tra JavaScript e code. Per iniziare, configura il tuo 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 testare 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à di ponte di base, procedere con la verifica di flussi di lavoro completi degli utenti.

Test dei plugin completi

Per garantire che il tuo plugin funzioni bene in diversi scenari, testare varie categorie:

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

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

Test di OTA con Capgo

Capgo strumenti open-source rendono facile l'implementazione e il test degli aggiornamenti in modo rapido. Ecco come utilizzarli:

1. Configurare canali di aggiornamento come dev, staging e production.
2. Automate le deployment con gli strumenti CI/CD.
3. Push le aggiornamenti istantaneamente.
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, adotta queste migliori pratiche:

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

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

Capgo Integration Guide

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 versione semantica chiara 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 gli aggiornamenti di distribuzione.

3. Monitoraggio degli Aggiornamenti
   Monitora i tassi di successo delle distribuzioni e assicurati di essere conforme alle 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.

La checklist PR evidenzia la necessità di sottoscrizioni di alta qualità. Se il tuo plugin supporta aggiornamenti in tempo reale, l'integrazione con Capgo (come menzionato in precedenza) può aiutarti a rilasciare aggiornamenti velocemente senza dover attendere l'approvazione delle app store.

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 l'aggiornamento alle novità di Capacitor assicureranno 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à complessiva dell'ecosistema e mantiene il tuo plugin utile per i developer.

Continua a seguire il Capacitor Guida alla Contribuzione dei Plugin

Se stai utilizzando la Capacitor Guida alla Contribuzione dei Plugin per pianificare il lavoro sui plugin nativi, connettilo con la Capgo Directory dei Plugin per il workflow del prodotto nella Capgo Directory dei Plugin, i Capacitor Plugins di Capgo per i dettagli di implementazione in Capacitor Plugins da Capgo Aggiunta o Aggiornamento dei Plugin per i dettagli di implementazione in Aggiunta o Aggiornamento dei Plugin Alternative per Plugin Enterprise Ionic per il workflow del prodotto in Alternative per Plugin Enterprise Ionic, e Capgo Build Nativi per il workflow del prodotto in Capgo Build Nativi.