Skip to content

💻 | Contribuer

Minilan edited this page Dec 22, 2024 · 3 revisions

Ce projet a été conçu pour répondre aux besoins spécifiques du serveur Djidjeyland, mais ton aide et tes idées sont toujours les bienvenues pour l’améliorer !

🛠️ Pourquoi contribuer ?

En participant au développement du bot, tu peux :

  • Apporter des améliorations ou corriger des bugs
  • Proposer de nouvelles fonctionnalités pour enrichir le bot
  • Participer à un projet amusant et utile pour la communauté

👣 Comment contribuer ?

1️⃣ Forker le projet

  • Accède au dépôt GitHub
  • Clique sur le bouton Fork pour créer une copie du projet dans ton propre compte

2️⃣ Créer ton environnement

  • Clone le dépôt forké sur ton ordinateur
  • Crée une branche pour tes changements
  • Installe les dépendances du projet en exécutant :
npm install

3️⃣ Préparer le fichier de configuration

  • Copie le fichier config-exemple.json en config.json
  • Ouvre le fichier config.json et remplace les valeurs par celles correspondant à ton environnement

    ⚠️ Attention : Ne partage jamais publiquement ton fichier config.json ou les infos qu'il contient !

4️⃣ Apporter tes modifications

Apporte les modifications nécessaires dans le code

5️⃣ Tester tes modifications

Avant de proposer tes changements, assure-toi qu’ils fonctionnent correctement et qu’ils n’introduisent pas de bugs

6️⃣ Proposer une Pull Request (PR)

  • Une fois tes modifications terminées, pousse-les sur GitHub
  • Va sur la page de ton fork sur GitHub et clique sur Pull Request

7️⃣ Discuter et collaborer

Ton PR sera examiné, et des retours pourraient t’être donnés pour peaufiner ton code. Une fois validé, tes modifications seront intégrées au projet principal !

📜 Règles de contribution

Pour garantir un projet de qualité, voici quelques règles à suivre :

  1. Respecte la structure et le style du code existant
  2. Documente tes modifications dans le code si nécessaire
  3. Si tu ajoutes une fonctionnalité, explique-la clairement dans ta Pull Request

📬 Suggestions et idées

Tu ne veux pas coder mais tu as une idée géniale ? Aucun problème !

  • Ouvre une Issue sur le dépôt GitHub pour détailler ton idée