Nous sommes ravis que vous souhaitiez contribuer à notre projet open source de gestion de vie étudiante Papillon ! Voici quelques éléments à prendre en compte avant de commencer :
Nous attendons de tous les contributeurs qu'ils respectent notre code de conduite. Veuillez lire attentivement le fichier CODE_OF_CONDUCT.md avant de contribuer.
Nous sommes heureux de recevoir des contributions de toutes formes et tailles. Voici quelques suggestions pour commencer :
Si vous rencontrez un bogue dans l'application, veuillez ouvrir une issue sur GitHub. Assurez-vous d'inclure une description claire et détaillée du bogue, ainsi que des étapes pour le reproduire.
Si vous avez une idée pour une nouvelle fonctionnalité, veuillez ouvrir une issue sur GitHub pour discuter de votre proposition. Nous sommes toujours à la recherche de nouvelles idées pour améliorer l'application.
Si vous avez des compétences techniques, vous pouvez contribuer en soumettant des pull requests. Voici les étapes à suivre :
- Clonez le dépôt GitHub.
- Créez une nouvelle branche à partir de la branche main.
- Effectuez vos modifications sur la nouvelle branche.
- Testez les modifications pour vous assurer qu'elles fonctionnent correctement.
- Vérifiez le style de votre code (avec
npm run lint)- S'il y a des erreurs qui peuvent être corrigés automatiquement, utilisez
npm run lint -- --fixpour les corriger. - Utilisez l'extension ESLint pour votre éditeur de code pour vous aider à respecter le style.
- S'il y a des erreurs qui peuvent être corrigés automatiquement, utilisez
- Soumettez une pull request en expliquant les modifications que vous avez apportées et en fournissant des captures d'écran si cela est pertinent. Nous examinerons votre pull request dès que possible et nous vous fournirons des commentaires pour vous aider à l'améliorer si nécessaire.
Le projet Papillon est sous licence GPLv3. En contribuant à ce projet, vous acceptez que vos contributions soient sous licence GPLv3 également.