Contribuer à AstroSpectro
Merci de l'intérêt que vous portez à ce projet ! Nous sommes ravis de voir que vous souhaitez contribuer. Toute contribution, de la simple correction d'une faute de frappe à l'ajout d'une nouvelle fonctionnalité, est la bienvenue et grandement appréciée.
Ce document vous guide à travers les différentes manières de participer.
Types de Contributions
Il n'est pas nécessaire d'être un expert en Python ou en astrophysique pour aider. Voici quelques exemples de contributions précieuses :
Rapporter un Bug
Si vous trouvez un comportement inattendu, une erreur, ou un problème dans la documentation, la meilleure chose à faire est d'ouvrir une Issue de Bug.
Suggérer une Amélioration
Vous avez une idée pour une nouvelle feature, une amélioration de l'algorithme, ou une nouvelle visualisation ? Ouvrez une Issue de Feature Request pour en discuter.
Contribuer au Code (Pull Requests)
Si vous souhaitez contribuer directement au code, voici le processus standard à suivre.
Étape 1 : Préparation
-
Forkez le dépôt : Cliquez sur le bouton "Fork" en haut à droite de la page GitHub du projet pour créer une copie du projet sur votre propre compte.
-
Clonez votre fork : Récupérez votre copie du projet sur votre machine locale.
git clone https://github.com/VOTRE-NOM-UTILISATEUR/AstroSpectro.git
cd AstroSpectro -
Créez une branche de travail : Ne travaillez jamais directement sur la branche
main
. Créez une nouvelle branche dédiée à votre modification.# Exemple : pour une feature d'ajout des raies TiO
git checkout -b feature/add-tio-lines
# Exemple : pour un bug dans le preprocessor
git checkout -b fix/preprocessor-normalization-buginfoUtilisez des noms de branche clairs avec des préfixes comme
feature/
,fix/
, oudocs/
pour indiquer la nature de votre changement.
Étape 2 : Développement
- Faites vos modifications : Écrivez votre code, corrigez le bug, ou améliorez la documentation.
- Suivez les normes du projet : Essayez de respecter le style de code existant (PEP8 pour Python).
- Testez vos changements : Assurez-vous que vos modifications ne cassent rien et qu'elles fonctionnent comme prévu.
Étape 3 : Soumission
- Commitez vos changements : Sauvegardez votre travail avec des messages de commit clairs.
git add .
git commit -m "Feat: Add feature extraction for TiO bands" - Poussez votre branche sur votre fork :
git push origin feature/add-tio-lines
- Ouvrez une Pull Request (PR) :
- Allez sur la page de votre fork sur GitHub. Un bouton "Compare & pull request" devrait apparaître.
- Cliquez dessus et remplissez le formulaire de la PR.
- Décrivez clairement ce que votre PR fait et pourquoi elle est utile. Si elle corrige une issue, liez-la en écrivant "Closes #123".
Une fois la PR ouverte, je la passerai en revue, je pourrai laisser des commentaires, et une fois qu'elle sera prête, elle sera fusionnée dans le projet principal.
Merci encore pour votre volonté de contribuer !