Ciao! Axiom Paths è una dispensa collaborativa dagli studenti, per gli studenti. Se stai leggendo questo file, significa che vuoi aiutare a migliorare le risorse matematiche per la nostra community universitaria.
📋 Tipi di Contributi
🔍 Correzioni e Miglioramenti
- Errori di battitura o LaTeX
- Dimostrazioni incomplete o poco chiare
- Aggiunta di passaggi mancanti
📚 Nuovi Contenuti
- Teoremi e definizioni
- Esercizi con soluzioni
- Note esplicative e intuizioni
- Collegamenti tra concetti
🏷️ Organizzazione
- Miglioramento dei tag esistenti
- Nuove categorie per esercizi
- Ottimizzazione della navigazione
🎨 Design e UX
- Miglioramenti alla leggibilità
- Ottimizzazioni per mobile
- Accessibilità
🚀 Come Iniziare
Setup Locale
- Fork del repository
axiom-paths - Clone la tua fork:
git clone https://github.com/giovyx90/axiom-paths.git - Obsidian: apri la vault clonata
- Quartz: setup per preview locale (opzionale)
Workflow di Contribuzione
- Crea un branch per il tuo contributo:
git checkout -b feature/nome-descrittivo - Effettua le modifiche in Obsidian
- Test locale: verifica che tutto funzioni
- Commit: messaggio chiaro e descrittivo
- Push e Pull Request
📝 Standard di Contenuto
Struttura delle Note
# Titolo del Concetto
## Definizione
> **Definizione X.Y** (Nome Teorema/Definizione)
> Testo matematico con LaTeX appropriato
## Dimostrazione/Spiegazione
Passaggi logici chiari con:
- Motivazione di ogni step
- Riferimenti a risultati precedenti
- Esempi quando utili
## Esempi
Almeno un esempio concreto
## Collegamenti
- [[Concetto Prerequisito]]
- [[Applicazione Successiva]]
## Tags
#tag-categoria #difficoltà #tipo-contenuto`
### Formattazione LaTeX
- Inline: `$x^2 + y^2 = 1$`
- Display:
~~~latex
$$
\begin{align}
f(x) &= ax^2 + bx + c \\
&= a(x + h)^2 + k
\end{align}
$$
~~~
- Teoremi: usa callout di Obsidian per evidenziare
Sistema di Tag
- Difficoltà:
#base#intermedio#avanzato - Tipo:
#teoria#esercizi#esame - Materia:
#geometria-I#analisi-I
🔍 Review Process
Prima di Sottomettere
- Controllo ortografico
- LaTeX renderizza correttamente
- Collegamenti funzionanti
- Tag appropriati
- Esempi verificati
Pull Request Guidelines
Titolo: [TIPO] Breve descrizione
[FIX]Correzioni[ADD]Nuovi contenuti[IMPROVE]Miglioramenti esistenti[REFACTOR]Riorganizzazione
Descrizione:
- Cosa cambia e perché
- Impatto sui contenuti esistenti
- Note per i reviewer
Code Review
I maintainer controlleranno:
- Accuratezza matematica
- Chiarezza
- Consistenza di stile
- Collegamenti con contenuti esistenti
🏆 Riconoscimenti
Contributors Hall
I contributor vengono riconosciuti in:
- File
CONTRIBUTORS.md - Sezione “About” del sito
- Release notes per contributi significativi
Modalità di Credito
- Major contributions: nome + profilo GitHub
- Regular contributors: lista in ordine alfabetico
- One-time fixes: menzione nei commit
💬 Comunicazione
Dove Chiedere Aiuto
- Discord (privato) al sottoscritto
- Email istituzionale: giovanni.albanese@edu.unifi.it
- Di persona (se sei della facoltà stessa mia)
- Se sei pratico con github, puoi usare pure gli issues.
- Puoi scegliere se rimanere anonimo o con un nickname.
Linguaggio
- Italiano
📜 Linee Guida della Community
Tono e Stile
- Accademico ma accessibile
- Peer-to-peer: da studenti per studenti
- Costruttivo: focus sul miglioramento continuo
- Inclusivo: rispetto per tutti i livelli di competenza
Best Practices
- Citare fonti quando appropriato
- Spiegare intuizioni oltre alle dimostrazioni formali
- Fornire esempi concreti per concetti astratti
- Complessità progressiva: dal semplice al complesso
Ready to contribute? Inizia esplorando le Issues etichettate good-first-issue o help-wanted. Grazie per il tuo aiuto nel rendere Axiom Paths una risorsa sempre migliore!