sbt-native-packager est un plugin pour SBT (Scala Build Tool) qui permet de convertir des applications Scala ou Java en formats natifs tels que les paquets Debian, RPM, ou les images Docker. Ce guide explique comment accéder à l'assistance de la communauté et participer au développement du projet.

Obtenir de l'aide de la communauté

Consulter les ressourecs documentaires

La documentation principale se trouve dans le répertoire src/sphinx du projet. Elle couvre les configurations de base et avancées pour différents formats de packaging. Pour générer une version HTML locale, exécutez la commande sbt sphinx:generateHtml.

Canaux de support et de discussion

• Utilisez les tags sbt ou sbt-native-packager sur Stack Overflow pour poser des questions techniques.
• Rejoignez la salle de discussion Gitter, liée dans le fichier README du projet, pour des échanges en temps réel.
• Soumettez des rapports de bugs ou des demandes de fonctionnalités via le système d'issues du dépôt, en vérifiant d'abord les tickets existants.

Diagnostiquer les problèmes courants

Pour les erreurs fréquentes liées à l'empaquetage ou à la configuration, effectuez une recherche sur Stack Overflow. Cette approche permet souvent de trouver des solutions déjà validées par la communauté.

Contribuer au code source

Prérequis pour une contribution

Avant de commenecr, lisez le fichier CONTRIBUTING.md à la racine du projet. Assurez-vous d'avoir installé les outils nécessaires comme SBT et un JDK, et familiarisez-vous avec les conventions de style de code et les exigences de test.

Flux de travail pour les contributions

Cloner le dépôt

Récupérez le code source depuis le référentiel principal :

git clone https://gitcode.com/gh_mirrors/sb/sbt-native-packager
cd sbt-native-packager

Créer une branche dédiée

Initiez une branche pour votre modification :

git checkout -b feature/nom-de-la-fonctionnalite

Développer et tester

Respectez les consignes de test selon le type de contribution :

• Pour le code Scala, formatez-le avec sbt scalafmtAll et indiquez la version de Scala utilisée.
• Pour les scripts Bash, mentionnez la version de Bash testée.
• Pour les fichiers batch Windows, précisez l'environnement (version de Windows, CMD ou PowerShell).

Exécuter les suites de tests

Lancez les tests correspondant à la plateforme cible :

# Pour Linux
sbt "scripted universal/* debian/* rpm/*"

# Pour Windows
sbt "scripted windows/*"

# Pour Docker
sbt "scripted docker/*"

Contribuer à la documentation

La documentation est rédigée en reStructuredText dans src/sphinx. Lors des modifications, assurez-vous que le contenu reste accessible aux débutants. Mettez à jour les sections pertinentes pour les nouvelles fonctionnalités. Prévisualisez les changements avec sbt sphinx:generateHtml.

Soumettre une Pull Request

Avant de proposer une PR, vérifiez que :

• Tous les tests passent.
• La documentation est synchronisée avec les modifications.
• Les messages de commit décrivent clairement les changements.
• Le code adhère aux directives de style du projet.

Règles de conduite communautaire

Le fichier CODE_OF_CONDUCT.md établit les normes de comportement, incluant le respect mutuel, l'attitude constructive envers les nouveaux membres, et la promotion d'un environnement inclusif. Les discussions doivent rester professionnelles et éviter les sujets sensibles.