Contribuire

🤝 Come Contribuire ad am8xControl

Siamo sempre felici di ricevere contributi per migliorare il modulo am8xControl! Che si tratti di risolvere un bug, implementare una nuova funzionalità o semplicemente migliorare la documentazione, il tuo aiuto è prezioso.

In questa pagina ti spieghiamo l'iter corretto per proporre modifiche e segnalare bug.

---

🐛 Segnalare Bug o Suggerire Soluzioni

Se hai trovato un bug o hai un'idea per una nuova funzionalità, il modo migliore per farcelo sapere è aprire una Issue.

1. Vai alla sezione Issues del repository.
2. Clicca sul pulsante New Issue.
3. Scegli un titolo descrittivo.
4. Per i Bug: Inserisci una descrizione dettagliata del problema, i passaggi per riprodurlo, il comportamento atteso e qualsiasi log di errore di Niagara.
5. Per le Soluzioni/Funzionalità: Descrivi la tua idea, il caso d'uso e possibilmente una bozza di soluzione.

---

💻 Lavorare al Proprio Branch (Pull Request)

Se vuoi mettere le mani sul codice e proporre una modifica diretta (Pull Request), segui questa procedura standard di Git (chiamata comunemente GitHub Flow):

1. Fai il Fork e Clona

Innanzitutto, fai un Fork del progetto premendo l'apposito pulsante in alto a destra sulla repository principale. Questo creerà una copia del progetto sul tuo account GitHub.

Clona la tua copia in locale:

git clone https://github.com/<tuo-username>/am8xControl.git
cd am8xControl

2. Crea un Branch per la tua modifica

Assicurati di essere sul branch main e scarica le ultime modifiche prima di iniziare:

git checkout main
git pull origin main

Ora crea un branch descrittivo per la tua modifica (es. fix-discovery-bug oppure feature/new-modbus-mapping):

git checkout -b feature/la-mia-modifica

3. Effettua le tue modifiche

Lavora al codice tramite IntelliJ, Eclipse o il tuo IDE preferito, usando Gradle per buildare e testare:

./gradlew build

4. Committa le Modifiche

Aggiungi le tue modifiche e fai un commit chiaro ed esplicativo:

git add .
git commit -m "Descrizione chiara di ciò che è stato fixato o aggiunto"

5. Pusha e Apri una Pull Request

Carica il tuo branch sul tuo repository su GitHub:

git push origin feature/la-mia-modifica

Vai alla pagina del repository originale (zEhmsy/am8xControl) e vedrai un banner giallo che ti invita a creare una Pull Request. Cliccalo, descrivi le modifiche fatte e inviala per la revisione!

6. Revisione (Code Review)

Un maintainer del progetto revisionerà il tuo codice. Se necessario, ti verranno chiesti dei piccoli accorgimenti prima di eseguire il merge finale all'interno del branch main.

---

🎉 Grazie in anticipo per il tuo contributo al progetto!