Contribuer

Le Wiki IA est un projet open source et collaboratif. Toute contribution est la bienvenue, qu'il s'agisse de corriger une faute de frappe, d'améliorer une explication ou d'ajouter du nouveau contenu.

Types de contributions

COMMENT CONTRIBUER :

┌─────────────────────────────────────────────────────────────┐
│                     CONTRIBUTIONS                            │
├────────────────┬────────────────┬───────────────────────────┤
│   CONTENU      │   TECHNIQUE    │   COMMUNAUTÉ              │
├────────────────┼────────────────┼───────────────────────────┤
│ • Nouvelles    │ • Corrections  │ • Signaler des            │
│   pages        │   de bugs      │   problèmes               │
│ • Corrections  │ • Amélioration │ • Proposer des            │
│ • Traductions  │   du design    │   idées                   │
│ • Exemples     │ • Performance  │ • Partager le             │
│   de code      │ • Accessibilité│   projet                  │
└────────────────┴────────────────┴───────────────────────────┘

Prérequis

Pour contribuer au code, vous aurez besoin de :

Node.js 18+ et pnpm
Git pour le versioning
Un éditeur de code (VS Code recommandé)

# Cloner le repository
git clone https://github.com/votre-username/wiki-ia.git
cd wiki-ia

# Installer les dépendances
pnpm install

# Lancer le serveur de développement
pnpm dev

Structure du projet

wiki-ia/
├── content/
│   └── docs/           # Pages de documentation (MDX)
│       ├── introduction/
│       ├── machine-learning/
│       ├── deep-learning/
│       ├── llm-ia-generative/
│       ├── applications/
│       ├── ethique/
│       ├── ressources/
│       └── glossaire/
├── src/
│   ├── app/           # Pages Next.js
│   ├── components/    # Composants React
│   └── lib/           # Utilitaires
├── public/            # Assets statiques
└── source.config.ts   # Configuration Fumadocs

Écrire du contenu

Format des pages

Les pages sont écrites en MDX (Markdown avec composants React) :

---
title: Titre de la page
description: Description courte pour le SEO
---

# Introduction

Votre contenu ici...

## Section avec code

\`\`\`python
def hello():
    print("Hello, World!")
\`\`\`

## Utiliser des composants

<Callout type="info">
Information importante pour le lecteur.
</Callout>

<Cards>
  <Card title="Lien 1" href="/docs/page1" />
  <Card title="Lien 2" href="/docs/page2" />
</Cards>

Composants disponibles

Composant	Usage
`<Callout>`	Mettre en évidence une information (info, warn, error)
`<Cards>` + `<Card>`	Grille de liens vers d'autres pages
`<Tabs>` + `<Tab>`	Contenu en onglets
`<Steps>`	Tutoriel étape par étape
`<Quiz>`	Quiz interactif

Conventions de style

Règles d'écriture

Écrire en français avec les termes techniques en anglais si nécessaire
Utiliser le vouvoiement
Rester accessible tout en étant techniquement rigoureux
Inclure des exemples de code fonctionnels
Citer les sources pour les affirmations techniques

Schémas ASCII

Pour les concepts complexes, utilisez des schémas ASCII :

RÉSEAU DE NEURONES :

Entrée         Couche cachée       Sortie
  ●─────────────────●─────────────────●
  ●─────────────────●─────────────────●
  ●─────────────────●

Ajouter une nouvelle page

1. Créer le fichier

# Créer une nouvelle page dans une section existante
touch content/docs/machine-learning/nouvelle-page.mdx

2. Ajouter le frontmatter

---
title: Titre de la nouvelle page
description: Description concise de la page
---

Votre contenu ici...

Ajoutez votre page au fichier meta.json de la section :

{
  "title": "Machine Learning",
  "pages": ["index", "supervise", "nouvelle-page"]
}

4. Ajouter des liens

Mettez à jour la page index de la section pour inclure un lien :

<Cards>
  <Card title="Nouvelle page" href="/docs/machine-learning/nouvelle-page" />
</Cards>

Workflow de contribution

PROCESSUS DE CONTRIBUTION :

1. FORK              2. BRANCH            3. COMMIT
   │                    │                    │
   ▼                    ▼                    ▼
┌─────────┐        ┌─────────┐         ┌─────────┐
│ Fork le │   →    │ Créer   │    →    │ Faire   │
│ repo    │        │ branche │         │ commits │
└─────────┘        └─────────┘         └─────────┘
                                            │
4. PUSH              5. PR               6. REVIEW
   │                    │                    │
   ▼                    ▼                    ▼
┌─────────┐        ┌─────────┐         ┌─────────┐
│ Push    │   →    │ Créer   │    →    │ Revue   │
│ branche │        │   PR    │         │ & merge │
└─────────┘        └─────────┘         └─────────┘

Étapes détaillées

# 1. Fork le repository sur GitHub

# 2. Cloner votre fork
git clone https://github.com/VOTRE-USERNAME/wiki-ia.git
cd wiki-ia

# 3. Créer une branche
git checkout -b feature/ma-contribution

# 4. Faire vos modifications
# ... éditez les fichiers ...

# 5. Vérifier que tout fonctionne
pnpm build

# 6. Commit avec un message clair
git add .
git commit -m "Ajout: nouvelle page sur les transformers"

# 7. Push vers votre fork
git push origin feature/ma-contribution

# 8. Créer une Pull Request sur GitHub

Messages de commit

Utilisez des préfixes clairs :

Préfixe	Usage
`Ajout:`	Nouvelle fonctionnalité ou contenu
`Fix:`	Correction de bug ou erreur
`Amélioration:`	Amélioration de contenu existant
`Style:`	Changement de style/formatage
`Docs:`	Modification de documentation
`Refactor:`	Refactorisation de code

Signaler un problème

Si vous trouvez une erreur ou avez une suggestion :

Vérifiez que le problème n'a pas déjà été signalé
Créez une Issue sur GitHub avec :
- Un titre descriptif
- La page concernée
- Une description du problème
- Si possible, une suggestion de correction

Bonnes pratiques

À éviter

Ne pas inclure d'informations personnelles ou sensibles
Éviter le contenu promotionnel ou les liens d'affiliation
Ne pas copier de contenu protégé par le droit d'auteur
Éviter les opinions non étayées par des sources

Qualité du contenu

Précision : Vérifiez vos informations avec des sources fiables
Clarté : Expliquez les concepts complexes simplement
Exemples : Incluez du code fonctionnel et testé
Accessibilité : Pensez aux lecteurs débutants

Revue de code

Avant de soumettre, vérifiez :

# Vérifier le build
pnpm build

# Vérifier le linting
pnpm lint

# Vérifier les types
pnpm types:check

Licence

En contribuant, vous acceptez que votre contribution soit publiée sous la même licence que le projet.

Merci pour votre intérêt ! Chaque contribution, même petite, améliore le wiki pour toute la communauté francophone intéressée par l'IA.

Besoin d'aide ?

Si vous avez des questions sur la contribution :

Ouvrez une Issue sur GitHub
Consultez les autres pages pour voir des exemples de format
N'hésitez pas à demander des clarifications dans votre Pull Request