Atomsk

Le couteau suisse pour les simulations atomiques

Contribuer

Vous voulez corriger un bogue, optimiser une routine, ajouter une nouvelle fonctionnalité, ou bien ajouter des traductions pour Atomsk ? Vos contributions sont bienvenues !

Envoyer directement vos fichiers

Si vous avez modifié un fichier existant de Atomsk, ou bien si vous en avez développé un nouveau, vous pouvez envoyer votre version modifiée directement par email. 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.

Utiliser Git et Github

Alternativement, une façon plus robuste et pratique de partager vos modifications, est d'utiliser un outil de versioning. 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é.

Obtenir la version de développement de Atomsk

Si vous souhaitez uniquement télécharger la dernière version de développement de Atomsk, alors créez un dossier sur votre ordinateur et tapez la commande suivante :

git clone https://github.com/pierrehirel/atomsk

Cependant, soyez prévenu que cette version peut contenir des fonctionnalités qui ne sont pas complètement implémentées, des bogues, et peut même ne pas compiler ou ne pas fonctionner du tout. Utilisez-la à vos propres risques.

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).

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.