Contribuer

Nous accueillons les contributions à IceGate ! Ce guide explique comment commencer.

Façons de ContribuerFaçons de ContribuerFaçons de Contribuer

• Signaler des bugs via GitHub Issues
• Demander des fonctionnalités via GitHub Issues
• Soumettre des pull requests pour des corrections de bugs ou des fonctionnalités
• Améliorer la documentation
• Partager vos retours et cas d'utilisation

Configuration du DéveloppementConfiguration du DéveloppementConfiguration du Développement

PrérequisPrérequisPrérequis

• Rust >= 1.92.0
• Docker et Docker Compose
• Git

Cloner et CompilerCloner et CompilerCloner et Compiler

# Cloner le dépôt
        git clone https://github.com/icegatetech/icegate.git
        cd icegate
        
        # Compiler le projet
        cargo build
        
        # Exécuter les tests
        cargo test
        

Démarrer l'Environnement de DéveloppementDémarrer l'Environnement de DéveloppementDémarrer l'Environnement de Développement

# Recommandé : Skaffold avec Kubernetes local
        skaffold dev
        
        # Alternative : Docker Compose avec rechargement à chaud
        make dev
        

Voir Environnement de Développement pour les détails complets sur les profils Skaffold et les options Docker Compose.

Style de CodeStyle de CodeStyle de Code

FormatageFormatageFormatage

Utilisez rustfmt avec la configuration du projet :

# Vérifier le formatage
        make fmt
        
        # Corriger automatiquement le formatage
        make fmt-fix
        

La configuration se trouve dans rustfmt.toml.

LintingLintingLinting

Utilisez clippy avec des paramètres stricts :

# Exécuter clippy
        make clippy
        
        # Corriger automatiquement les problèmes
        make clippy-fix
        

La configuration se trouve dans clippy.toml.

Vérifications CIVérifications CIVérifications CI

Avant de soumettre, exécutez toutes les vérifications CI :

make ci
        

Cela exécute :

1. cargo check - vérification de la compilation
2. cargo fmt -- --check - vérification du formatage
3. cargo clippy -- -D warnings - linting
4. cargo test - tests
5. cargo audit - audit de sécurité

Structure du ProjetStructure du ProjetStructure du Projet

crates/
        ├── icegate-common/      # Infrastructure partagée (catalogue, stockage, métriques, traçage)
        ├── icegate-catalog-s3/  # Catalogue Iceberg sur S3 (par défaut) et son serveur REST
        ├── icegate-queue/       # Write-ahead log (Parquet sur stockage objet)
        ├── icegate-query/       # Service Query (Loki/Tempo/Flight SQL ; routes Prometheus 501)
        ├── icegate-ingest/      # Service Ingest (OTLP HTTP/gRPC, WAL, shift)
        └── icegate-maintain/    # Migration, compaction, GC des orphelins, crawler de tarifs
        

Le framework de jobs/tâches n'est pas un crate du workspace : il réside dans icegatetech/jobmanager et est consommé comme dépendance git épinglée.

Voir l'Architecture pour les détails.

Directives pour les Pull RequestsDirectives pour les Pull RequestsDirectives pour les Pull Requests

Avant de SoumettreAvant de SoumettreAvant de Soumettre

1. Créez une issue d'abord pour les changements significatifs
2. Discutez de l'approche avant l'implémentation
3. Exécutez les vérifications CI localement : make ci
4. Écrivez des tests pour les nouvelles fonctionnalités
5. Mettez à jour la documentation si nécessaire

Description de la PRDescription de la PRDescription de la PR

Incluez :

• Résumé des changements
• Numéro de l'issue associée
• Tests effectués
• Changements incompatibles (le cas échéant)

Processus de ReviewProcessus de ReviewProcessus de Review

1. Soumettez la PR contre la branche main
2. Attendez que les vérifications CI passent
3. Adressez les retours de review
4. Squashez les commits si demandé
5. Le mainteneur merge une fois approuvé

TestsTestsTests

Exécution des TestsExécution des TestsExécution des Tests

# Tous les tests
        cargo test
        
        # Test spécifique
        cargo test test_name
        
        # Avec affichage de la sortie
        cargo test -- --nocapture
        
        # Tests d'intégration
        cargo test --test '*'
        

Écriture des TestsÉcriture des TestsÉcriture des Tests

• Tests unitaires dans le même fichier que l'implémentation
• Tests d'intégration dans le répertoire tests/
• Utilisez des noms de tests descriptifs
• Testez les cas de succès et d'erreur

DocumentationDocumentationDocumentation

Documentation du CodeDocumentation du CodeDocumentation du Code

Tous les éléments publics doivent avoir une documentation :

/// Parses a LogQL query string into an AST.
        ///
        /// # Arguments
        ///
        /// * `query` - The LogQL query string
        ///
        /// # Returns
        ///
        /// The parsed LogQL expression or an error
        pub fn parse(query: &str) -> Result<LogQLExpr> {
            // ...
        }
        

Documentation UtilisateurDocumentation UtilisateurDocumentation Utilisateur

La documentation utilisateur se trouve dans docs/ en utilisant Diplodoc (YFM Markdown).

# Compiler la documentation
        cd docs && npm run build
        
        # Servir la documentation localement
        cd docs && npm run serve
        

Processus de ReleaseProcessus de ReleaseProcessus de Release

Les releases sont créées par les mainteneurs :

1. Mettre à jour la version dans Cargo.toml
2. Mettre à jour CHANGELOG.md
3. Créer un tag git
4. GitHub Actions compile et publie

Obtenir de l'AideObtenir de l'AideObtenir de l'Aide

• GitHub Issues : Signaler des bugs et demander des fonctionnalités
• Discussions : Poser des questions et partager des idées

Code de ConduiteCode de ConduiteCode de Conduite

Soyez respectueux et inclusif. Nous suivons le Code de Conduite Rust.

Étapes SuivantesÉtapes SuivantesÉtapes Suivantes

• Revoir la Compilation
• Comprendre les Patterns de Développement
• Explorer l'Architecture