👩🏽‍🍳 Guide de Contribution

Introduction

Contribuer à un projet open source est une excellente manière de s'améliorer en tant que développeur et d'aider une communauté. Toutes les contributions sont les bienvenues et seront reconnues.

Discussion préalable

Avant de soumettre une modification, discutez-en d'abord avec les mainteneurs via e-mail ou en créant une issue sur GitHub. Cela permet de valider l'orientation de votre proposition avant de commencer le travail.

Veuillez respecter le code de conduite du projet lors de vos interactions.

Comment contribuer

Le projet accepte les contributions via des Pull Requests sur Framework ou App. Voici les étapes pour bien contribuer :

1. Forker le projet :

• Rendez-vous sur la page du projet sur GitHub.
• Cliquez sur le bouton "Fork" pour copier le projet dans votre compte.

2. Créer une branche :

• Donnez un nom descriptif à votre branche reflétant les modifications apportées.
• Exemple :

git checkout -b fix-login-bug

3. Coder et documenter :

• Implémentez vos changements avec des messages de commit clairs (voir la section « Format des messages de commit »).
• Si vos modifications impactent la logique ou l'utilisation, mettez à jour la documentation du projet.

4. Ajouter des tests unitaires :

• Assurez-vous que vos changements sont accompagnés de tests qui garantissent leur fonctionnement.
• Exemple : si vous ajoutez une nouvelle fonctionnalité, écrivez des tests pour vérifier les scénarios principaux et les cas limites.

Tests

Exécutez composer test --testdox pour vérifier que tous les tests passent avant de soumettre votre Pull Request.

5. Soumettre une Pull Request :

• Poussez vos modifications sur votre répertoire forké :

git push origin fix-login-bug

• Allez sur la page GitHub du projet et créez une Pull Request en veillant à décrire clairement les modifications apportées.

Règles pour les Pull Requests

• Un Pull Request par fonctionnalité : Si vous souhaitez contribuer à plusieurs aspects du projet, créez une Pull Request distincte pour chaque modification.
• Mise à jour de version : Si votre contribution modifie de manière significative le comportement du projet, indiquez comment elle affecte la version en suivant le schéma SemVer.

Format des messages de commit

Pour garantir une bonne maintenance du projet, utilisez un format standardisé pour vos messages de commit suivant la convention Conventional Commits.

Préfixes recommandés

• refactor : Changement interne qui n'affecte pas le comportement utilisateur.
• fix : Corrige un bug existant.
• feat : Ajoute une nouvelle fonctionnalité.
• test : Ajoute ou met à jour des tests unitaires.
• docs : Modifications de la documentation.
• chore : Tâches de maintenance (dépendances, configuration, etc.).

Exemple de message de commit

1. Changement général :

git commit -m "fix: correct login issue when using special characters"

2. Changement dans une section spécifique :

git commit -m "fix(session): resolve token expiration bug"

3. Changement touchant plusieurs sections : Si votre modification affecte plusieurs parties, ajoutez une description plus détaillée :

git commit

Dans l'éditeur :

feat(auth): implement OAuth2 login

- Added OAuth2 support for Google and Facebook.
- Updated session handling for third-party logins.

Langue

Les messages de commit doivent être rédigés en anglais pour faciliter la collaboration internationale.

Bonnes pratiques

• Qualité du code : Respectez les standards de codage du projet. Consultez le fichier CONTRIBUTING.md pour plus de détails.
• Relecture : Révisez vos modifications avant de soumettre le Pull Request pour éviter les erreurs.
• Collaborer : Soyez ouvert aux retours et prêt à ajuster vos contributions en fonction des commentaires des mainteneurs.
• Tests : Assurez-vous que tous les tests passent et que votre code est couvert par des tests.

astuce

Utilisez composer format pour formater automatiquement votre code selon les standards PSR-2.

En suivant ces étapes, vous contribuez à la croissance et à la stabilité du projet tout en gagnant de précieuses compétences en développement collaboratif !

Il manque quelque chose ?

Si vous rencontrez des problèmes avec la documentation ou si vous avez des suggestions pour améliorer la documentation ou le projet en général, veuillez déposer une issue pour nous, ou envoyer un tweet mentionnant le compte Twitter @bowframework ou sur directement sur le github.