Atomsk

Le couteau suisse pour les simulations atomiques

Contribuer

Atomsk peut encore être amélioré de bien des façons. Si vous souhaitez contribuer, alors vous pouvez modifier le code source afin de corriger un bogue, optimiser une routine, ajouter une nouvelle fonctionnalité, ou bien modifier ou ajouter des traductions des messages. Vous pouvez aussi traduire la documentation de Atomsk, afin que les utilisateurs puissent la lire dans leur langue maternelle. Vos contributions sont bienvenues !

Rapporter un bogue

Si vous avez trouvé un bogue en exécutant Atomsk, vous pouvez ouvrir un rapport sur GitHub, ou bien contacter directement l'auteur par email.

Un "bogue" peut être n'importe que type de comportement non désiré : un résultat incorrect ou incohérent, une mauvaise traduction, un plantage ou une erreur de segmentation. Lorsque vous soumettez un rapport de bogue, veuillez indiquer quelle version d'Atomsk vous utilisez, et la commande qui produit ce bogue. Aussi, si possible, expliquez quel résultat vous vous attendez à obtenir, et pourquoi vous pensez que le résultat produit par Atomsk est faux.

Utiliser Git et Github

Atomsk est développé en utilisant Git, et le développement est rendu public sur le site GitHub. Pour apprendre à utiliser git (le gestionnaire de version en lui-même), et comment utiliser Github (la plate-forme qui héberge Atomsk), les liens suivants peuvent être un bon début :

N'hésitez pas également à demander d'autres informations et tutoriels à votre moteur de recherche préféré.

Comment contribuer à Atomsk

Si vous souhaitez contribuer à Atomsk, suivez les étapes suivantes :

  1. Créez votre propre compte sur GitHub.com. Veuillez utiliser vos vrais nom et prénom (et non pas un pseudonyme).
  2. Rendez-vous sur la page GitHub de Atomsk, et cliquez sur le bouton "Fork" ; ceci va créer une copie de Atomsk sur votre compte GitHub.
  3. Récupérez votre copie sur votre ordinateur local, comme vous le feriez avec n'importe quel dépôt GitHub :
  4. git clone https://github.com/mon_nom/mon_depot

  5. Maintenant, au lieu de travailler directement sur votre branche principale "master" (ce qui pourrait créer des conflits), il est plus sûr de créer votre propre branche séparée :

    git checkout -b ma_branche

  6. Travaillez sur votre propre copie de Atomsk, modifiez les fichiers à votre guise. Compilez votre version pour vérifier que vos modifications fonctionnent bien. N'oubliez pas d'insérer des commentaires dans votre code source.
  7. Une fois votre travail terminé, validez vos modifications (avec des commentaires !) :

    git commit -a


    Puis poussez-les vers votre dépôt GitHub :

    git push origin ma_branche


    Git demande alors vos identifiants GitHub.
  8. Ouvrez votre navigateur Web, rendez-vous sur la page GitHub de votre dépôt, et cliquez sur le bouton "Pull request".

Vos modifications apparaîtront à l'auteur principal comme une demande de tirage ("Pull request"). Après avoir vérifié vos modifications, l'auteur principal peut les accepter et les fusionner ("merge") dans la version principale de Atomsk (ou pas).

Envoyer une version modifiée par email

Si vous ne pouvez ou ne souhaitez pas utiliser GiHub, vous pouvez envoyer votre version modifiée directement par email. Dans ce cas, veuillez archiver la totalité de votre version modifiée de Atomsk (au format zip ou tar.gz) avant de l'envoyer. Si possible ou si c'est pertinent, vous pouvez également envoyer des scripts illustrant les changements que vous avez effectués.

Important : règles d'utilisation et bonne conduite

Les contributions sont bienvenues. Les contributions sont très bien. Mais pour éviter qu'elles soient chaotiques, veuillez respecter les quelques règles de bienséance ci-dessous lorsque vous contribuez à Atomsk.