Atomsk

Il coltellino svizzero delle simulazioni atomiche

Contribuire

Atomsk utilizza la libreria LAPACK, i cui autori sono calorosamente ringraziati.

Rivolgo un ringraziamento speciale alle seguenti persone, per i loro significativi contributi ad Atomsk (le affiliazioni corrispondono al momento del primo contributo):

Infine, ringrazio i cacciatori di bug, i cui post hanno contribuito a migliorare l'affidabilità e l'accuratezza del programma:

Vuoi contribuire?

Atomsk può ancora essere migliorato in molti modi. Se desideri contribuire, puoi modificare il codice sorgente per correggere un bug, ottimizzare una routine, aggiungere una nuova funzionalità o modificare o aggiungere traduzioni dei messaggi. Puoi anche tradurre la documentazione di Atomsk, in modo che gli utenti possano leggerla nella loro lingua madre. I tuoi contributi sono i benvenuti!

Segnalare un bug

Se hai trovato un bug durante l'esecuzione di Atomsk, puoi aprire un report su GitHub o contattare direttamente l'autore via email.

Un "bug" può essere qualsiasi tipo di comportamento indesiderato: un risultato errato o incoerente, una cattiva traduzione, un crash o un segfault. Quando invii una segnalazione di bug, indica quale versione di Atomsk stai utilizzando e il comando che produce questo bug. Inoltre, se possibile, spiega quale risultato ti aspetti di ottenere e perché pensi che il risultato prodotto da Atomsk sia sbagliato.

Usa Git e Github

Atomsk è sviluppato utilizzando Git e lo sviluppo è reso pubblico sul sito GitHub. Per imparare a usare git (il gestore di rilascio stesso) e come usare Github (la piattaforma che ospita Atomsk), i seguenti collegamenti possono essere un buon inizio:

Inoltre, sentiti libero di richiedere ulteriori informazioni e tutorial dal tuo motore di ricerca preferito.

Come contribuire ad Atomsk

Se desideri contribuire ad Atomsk, segui questi passaggi:

  1. Crea il tuo account su GitHub.com. Si prega di utilizzare il proprio vero nome e cognome (e non uno pseudonimo).
  2. Vai alla pagina GitHub di Atomsk e fai clic sul pulsante "Fork"; questo creerà una copia di Atomsk sul tuo account GitHub.
  3. Controlla la tua copia sul tuo computer locale, come faresti con qualsiasi repository GitHub:
  4. git clone https://github.com/mon_nom/mon_depot

  5. Ora, invece di lavorare direttamente sul tuo ramo principale "master" (che potrebbe creare conflitti), è più sicuro creare il tuo ramo separato:

    git checkout -b ma_branche

  6. Lavora sulla tua copia di Atomsk, modifica i file come desideri. Compila la tua versione per verificare che le tue modifiche funzionino bene. Non dimenticare di includere commenti nel codice sorgente.
  7. Una volta terminato il lavoro, conferma le modifiche (con i commenti!):

    git commit -a


    Quindi inviali al tuo repository GitHub:

    git push origin ma_branche


    Git chiede quindi le tue credenziali GitHub.
  8. Apri il tuo browser Web, vai alla pagina GitHub del tuo repository e fai clic sul pulsante "Pull request".

Le tue modifiche appariranno all'autore principale come una richiesta pull. Dopo aver verificato le modifiche, l'autore principale può accettarle e unirle alla versione principale di Atomsk (o meno).

Invia una versione modificata via e-mail

Se non puoi o non vuoi utilizzare GiHub, puoi inviare direttamente tramite e-mail la versione modificata . In questo caso, archivia l'intera versione modificata di Atomsk (in formato zip o tar.gz) prima di inviarla. Se possibile o pertinente, puoi anche inviare script che illustrino le modifiche apportate.

Importante: regole d'uso e buona condotta

I contributi sono benvenuti. I contributi vanno bene. Ma per evitare che sia caotico, per favore rispetta le poche regole di etichetta qui sotto quando contribuisci ad Atomsk.