RULES
Scopo
Il presente documento definisce le regole generali dell'ecosistema B-Arts.
Le regole riportate in questo documento sono valide per tutti i framework, le estensioni, gli strumenti e la documentazione dell'ecosistema, salvo diversa indicazione.
Principi generali
Lo sviluppo dell'ecosistema B-Arts si basa sui seguenti principi:
Semplicità.
Chiarezza.
Coerenza.
Riutilizzo.
Manutenibilità.
Retrocompatibilità, ove possibile.
Regole di progettazione
Durante lo sviluppo devono essere rispettate le seguenti regole:
Evitare duplicazioni di codice.
Preferire il riutilizzo di componenti già esistenti.
Mantenere API semplici, coerenti e prevedibili.
Ridurre al minimo le dipendenze tra componenti.
Ogni componente deve avere una responsabilità ben definita.
Regole della documentazione
La documentazione deve:
Essere coerente con il codice sorgente.
Essere aggiornata contestualmente al codice.
Evitare duplicazioni di contenuto.
Utilizzare riferimenti agli altri documenti quando necessario.
Documentare esclusivamente l'argomento trattato.
Priorità
In caso di conflitto tra più fonti, si applica il seguente ordine di priorità:
Codice sorgente.
RULES.md.
Documentazione specifica.
Esempi.
Altra documentazione.
Eccezioni
Ogni eccezione alle presenti regole deve essere esplicitamente documentata nel documento interessato.
