📑 Table des Matières

• Contribuer à Carch

  • Comprendre la Base de Code
  • Étapes pour Contribuer

• Contribuer à la Documentation Carch

• Directives

Contribuer à Carch

Nous sommes ravis que vous souhaitiez contribuer à Carch ! Les contributions de toutes sortes sont les bienvenues, que vous corriviez des bugs, ajoutiez de nouvelles fonctionnalités ou amélioriez la documentation. Suivez ce guide pour commencer.

WARNING

Avant de faire toute contribution, ouvrez d'abord un ticket dans la section Demande de Fonctionnalité. Nous discuterons des modifications là-bas avant de procéder à l'implémentation.

📌 Comprendre la Base de Code

NOTE

Avant de contribuer, comprenez la structure de Carch :

• Les fichiers Rust principaux de Carch se trouvent dans : src

src/
├── ui/
│   ├── app.rs
│   ├── mod.rs
│   ├── popups.rs
│   └── render.rs 
├── main.rs 
├── commands.rs
├── display.rs
├── script_list.rs 
└── version.rs

• Tous les scripts de modules sont organisés par catégorie dans :

modules/
├── Browser/     # Scripts liés aux navigateurs 
├── Desktop/     # Scripts liés aux environnements de bureau
├── Development/ # Scripts d'outils de développement
├── System/      # Scripts de configuration système
└── Terminal/    # Scripts de configuration de terminal

IMPORTANT

D'abord, analysez comment fonctionne le script avant de faire des modifications. Si vous voulez améliorer ou ajouter au projet, assurez-vous de comprendre la structure et comment chaque élément interagit. Cela vous aidera à contribuer de manière cohérente avec la conception du projet.

Pour les commits, utilisez des étiquettes comme
feat: votre-message-de-commit ou fix: votre-message-de-commit.

Au fait, avant de faire un commit, si vous modifiez un fichier .sh ou un script Bash, assurez-vous de vérifier le dossier scripts/ et d’exécuter ./check.sh pour détecter les espaces blancs ou vides en trop. Si cela échoue, exécutez ./cleanup.sh. Ceci est uniquement pour les scripts Bash.
Pour les fichiers Rust, assurez-vous d’exécuter cargo fmt --all --check. S’il y a des suggestions, exécutez cargo fmt --all.
Assurez-vous également d’exécuter cargo clippy et cargo clippy -- -Dwarnings pour vous assurer qu’il ne reste aucune erreur. Merci.

Pour plus d'informations sur les Commits Conventionnels, consultez ce guide.

Si vous avez des questions ou besoin d'aide, n'hésitez pas à nous contacter :
📧 Email : [email protected]
💬 Discord : Rejoignez-nous ici

Étapes pour Contribuer

1. 🍽️ Forker le Dépôt

• Allez sur la page GitHub de Carch.
• Cliquez sur le bouton Fork dans le coin supérieur droit pour créer votre propre copie du dépôt.

2. 🌿 Cloner le Dépôt Forké

• Utilisez la commande suivante pour cloner le dépôt sur votre système local :

  git clone https://github.com/votre-nom-utilisateur/carch.git

• Remplacez votre-nom-utilisateur par votre nom d'utilisateur GitHub.

💡 ASTUCE

Vous pouvez également utiliser des outils GUI comme GitHub Desktop ou même l'interface web de GitHub pour forker et cloner des dépôts. Ces outils fournissent une interface visuelle facile à utiliser pour gérer vos contributions.

3. 🌱 Définir le Dépôt Original comme Upstream

• Ajoutez le dépôt Carch original comme remote upstream pour maintenir votre fork à jour :

  cd carch

  git remote add upstream https://github.com/original-author/carch.git

4. 🍇 Créer une Nouvelle Branche de Fonctionnalité

• Avant de faire des modifications, créez une nouvelle branche avec un nom descriptif :

  git checkout -b feature/nom-de-votre-branche

• Exemples de noms de branches :

  • feature/ajouter-nouveau-script
  • bugfix/corriger-probleme-installation

5. 🔧 Faire Vos Modifications

• Implémentez les modifications nécessaires au code ou à la documentation.
• Assurez-vous que vos modifications sont claires, testées et suivent les standards de codage du projet.

6. 📝 Indexer et Commiter Vos Modifications

• Ajoutez les fichiers modifiés à la zone de staging :

  git add .

• Commitez vos modifications avec un message clair :

  git commit -m "Ajout : [brève description de vos modifications]"

7. 🚀 Pousser les Modifications vers Votre Fork

• Poussez votre branche vers votre dépôt forké :

  git push origin feature/nom-de-votre-branche

8. 📥 Soumettre une Pull Request (PR)

• Allez sur le dépôt Carch original sur GitHub.
• Cliquez sur New Pull Request.
• Sélectionnez votre branche dans le menu déroulant et décrivez vos modifications en détail.
• Soumettez la PR pour révision !

📚 Contribuer à la Documentation Carch

La Documentation Carch est ➥ Disponible ici

🚀 Façons de Contribuer

Vous pouvez contribuer en :

• 🪛 Corrigeant des fautes de frappe ou des erreurs dans les guides existants
• 🌐 Traduisant la documentation dans d'autres langues (fortement encouragé !)

🌍 Traduire la Documentation

Voulez-vous aider à rendre Carch accessible aux utilisateurs du monde entier ? Aidez-nous à traduire la documentation !

Si vous contribuez une nouvelle langue, suivez ces étapes :

1. 📁 Créez un nouveau dossier pour votre langue dans le répertoire docs/. Utilisez les codes ISO 639-1 (ex. fr, es, hi, etc.).
2. 🛠️ Traduisez le contenu Markdown dans le nouveau dossier.
3. 🧩 Modifiez docs/.vitepress/config.ts :
   • Ajoutez votre langue dans la section locales.
   • Fournissez un label, lang, et link pour la navigation.

🧪 Tester Vos Modifications Localement

Pour prévisualiser vos modifications :

bun install
bun run docs:dev

IMPORTANT

Veuillez d'abord ouvrir un ticket si vous prévoyez d'introduire des changements structurels ou organisationnels majeurs. Nous aimerions en discuter et collaborer dessus au préalable !

🧾 Style de Commit

Utilisez des messages de commit clairs comme :

git commit -m "fix(docs): corriger faute de frappe dans le guide d'installation"
git commit -m "feat(docs): ajouter traduction Hindi"

Plus d'infos sur les Commits Conventionnels.

🙌 Merci d'aider à améliorer la documentation !

Directives

Qualité du Code

• Suivez le style de codage existant du projet.
• Écrivez du code clair, concis et bien documenté.

Tests

• Testez vos modifications localement pour vous assurer qu'elles fonctionnent comme prévu.
• Si vos modifications introduisent de nouvelles fonctionnalités, ajoutez les tests nécessaires le cas échéant.

Documentation

• Si vos modifications impliquent de nouvelles fonctionnalités, mettez à jour la documentation pertinente.
• Assurez-vous que le README ou le Wiki reflète vos mises à jour.

Synchroniser Votre Fork

• Maintenez votre fork à jour pour éviter les conflits :

  git fetch upstream

  git merge upstream/main

  • Remplacez main par la branche par défaut du dépôt si elle est différente.

Merci de contribuer à Carch ! Votre effort aide à améliorer ce projet pour tout le monde.