Skip to content

Latest commit

 

History

History
90 lines (61 loc) · 3.31 KB

CONTRIBUTING.fr-FR.md

File metadata and controls

90 lines (61 loc) · 3.31 KB
Raw

Contribuer

English | 简体中文 | Deutsch | Français | Español

Processus

  1. Soumettez un problème décrivant les modifications que vous souhaitez apporter. S'il s'agit uniquement de modifications mineures/corrections de bogues, vous pouvez passer directement à l'étape 3.

  2. Après avoir discuté de la portée dans le problème, assignez-le vous-même. Il devrait apparaître dans la colonne "À faire" du projet OpenBot.

  3. Forkez le projet et clonez-le localement :

    git clone https://github.com/<user_id>/OpenBot.git

  4. Créez une branche :

    git checkout -b <nom-de-branche>

    où <nom-de-branche> décrit de manière concise la portée du travail.

  5. Faites le travail, écrivez de bons messages de commit, poussez votre branche vers le dépôt forké :

    git add <fichier modifié>
git commit -m <description significative>
git push --set-upstream origin <nom-de-branche>

  6. Créez une pull request sur GitHub et liez-y le problème. Il devrait apparaître dans la colonne "En cours" du projet OpenBot.

  7. Travaillez sur les retours de révision de code que vous pourriez recevoir et poussez-les vers votre fork. La pull request se met à jour automatiquement.

  8. Prenez une boisson fraîche de votre choix pour vous récompenser d'avoir rendu le monde meilleur.

Directives

  • Utilisez le même style et formatage que le reste du code.
    • Pour le code Java (Android) et Python, voir ci-dessous.
    • Pour tout autre code, essayez simplement de vous fondre dans le style existant.
  • Mettez à jour la documentation associée aux modifications de code que vous avez apportées.
  • Si vous souhaitez inclure des dépendances tierces, veuillez en discuter d'abord dans le problème.
  • Les pull requests doivent implémenter des fonctionnalités uniques avec le moins de modifications possible.
  • Assurez-vous de ne pas inclure de fichiers temporaires ou binaires (les gitignores devraient s'en charger pour la plupart).
  • Rebasez/fusionnez master dans votre branche avant de soumettre la pull request.
  • Si possible, testez votre code sur Windows, Linux et OSX.

Formatage

Java

Nous utilisons un script gradle pour formater le code java. Assurez-vous d'être dans le répertoire android.

Vous pouvez vérifier votre code avec :

./gradlew checkStyle

Vous pouvez appliquer le style à tous les fichiers en exécutant :

./gradlew applyStyle

Python

Nous utilisons black pour formater le code python.

Vous pouvez vérifier votre code dans le répertoire actuel avec :

black --check .

Vous pouvez appliquer le style à tous les fichiers dans le répertoire actuel en exécutant :

black .

Ressources supplémentaires

Si vous cherchez plus d'informations sur la contribution aux projets open-source, voici deux bonnes références :

Merci beaucoup !