Contribuire
Questa sezione della documentazione è la guida per i contributori del repository. Il progetto è nato come sostituto interno di Charles, ma il repo viene strutturato in modo che anche i contributori esterni possano capire:- come eseguire l’area di lavoro
- dove va inserito il codice
- come proporre modifiche in modo pulito
- come vengono create le release
- quale etichetta di revisione è prevista
Ordine di lettura consigliato
- Guida rapida per la configurazione locale
- Ambiente per le variabili di runtime
- Architettura per contributori per la struttura del repo
- Sviluppo per gli standard quotidiani
- Flusso di contribuzione prima di aprire una PR
- Skill per contributori per i workflow degli agent locali al repo
- Etichetta per issue e PR prima di richiedere una revisione
- Processo di release se il tuo lavoro incide sulla pubblicazione
Posizione OSS attuale
- Il repo è pensato per essere pubblico, ma la terminologia è ancora molto orientata al prodotto perché sta sostituendo una dipendenza da un vendor attivo.
- La documentazione dovrebbe spiegare il comportamento attuale, non solo l’architettura target.
- I contributori dovrebbero preferire modifiche piccole e revisionabili rispetto a refactor ampi e speculativi.
- Le pull request solo di documentazione sono benvenute se riducono l’ambiguità, rendono più precise le istruzioni di configurazione o chiariscono i contratti di runtime.
Buone prime aree di contribuzione
- Navigazione Mintlify e chiarezza delle pagine
- Documentazione dei contratti API e webhook
- Precisione di ambiente/configurazione
- Copertura Storybook per nuove primitive UI
- Test su compatibilità e comportamento a runtime