Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
78 lines (52 loc) · 3.3 KB

CONTRIBUTING.md

File metadata and controls

78 lines (52 loc) · 3.3 KB

Guide de Contribution - BookFind

Merci de vouloir contribuer à BookFind ! Ce guide décrit les étapes pour contribuer efficacement au projet.

Table des matières

  1. Code de Conduite
  2. Comment Contribuer
  3. Configuration de l'Environnement
  4. Style de Code
  5. Proposition de Fonctionnalités
  6. Signalement de Problèmes
  7. Processus de Demande de Tirage (Pull Request)

Code de Conduite

Ce projet adhère à un Code de Conduite afin de garantir un environnement respectueux pour tous les contributeurs.

Comment Contribuer

Types de Contributions

  • Corrections de bugs : Identifiez, corrigez et signalez des erreurs.
  • Améliorations de fonctionnalités : Proposez des améliorations pour les fonctionnalités existantes.
  • Documentation : Aidez à améliorer la documentation en ajoutant des exemples ou en clarifiant les sections.

Processus de Contribution

  1. Fork le dépôt et clonez-le localement.
  2. Créez une nouvelle branche avec un nom descriptif (ex : feature).
  3. Effectuez vos modifications sur cette branche.
  4. Testez et assurez-vous que le code est fonctionnel avant de faire une demande de tirage (pull request).

Configuration de l'Environnement

  1. Assurez-vous d’avoir installé les versions requises de PHP et MySQL.
  2. Cloner le projet : 
    git clone https://gitlab.com/chromared/bookfind.git
  3. Installez les dépendances requises et configurez votre base de données locale comme décrit dans le fichier README.md.
  4. Vérifiez que toutes les pages fonctionnent correctement après chaque changement.

Style de Code

  • Indentation : Utilisez des espaces (4 par niveau d’indentation).
  • Nommage : Utilisez des noms de variables et de fonctions explicites en anglais.
  • Commentaires : Commentez les parties complexes du code pour faciliter la compréhension des autres contributeurs.

Proposition de Fonctionnalités

Si vous souhaitez proposer une nouvelle fonctionnalité :

  1. Ouvrez une issue pour discuter de l'idée avec les mainteneurs.
  2. Fournissez une description détaillée de la fonctionnalité et des raisons de son ajout.
  3. Attendez les retours avant de commencer à travailler dessus.

Signalement de Problèmes

Pour signaler un problème :

  1. Ouvrez une issue avec un titre clair et une description détaillée.
  2. Fournissez les étapes pour reproduire le problème, les résultats attendus, et les résultats obtenus.
  3. Joignez des captures d’écran si cela aide à mieux comprendre le problème.

Processus de Demande de Tirage (Pull Request)

  1. Vérifiez que le code est testé et respecte les directives de style.
  2. Faites une pull request depuis votre branche vers main.
  3. Décrivez vos changements dans la pull request et mentionnez l'issue concernée (si applicable).
  4. Attendez la revue d’un mainteneur qui pourra fusionner votre contribution.

Merci de suivre ces instructions ! Avec votre aide, nous pouvons améliorer BookFind pour tous les utilisateurs.