CFR25 - OverTheRainBot

Important !!

N'oubliez pas de commit et push votre code pour que tout le monde y ait accès

Bienvenue sur le Github de OverTheRainBot

Vous pouvez retrouver ici les différentes versions des codes.

Voici quelques vidéos pour comprendre Git et Github, je vous conseille de regarder les deux premières :

• Pour comprendre Git en 2 min

• Git et Github les bases, largement suffisant !

• Facultatif : Va plus loin mais plus long, très complete !

Codes

Les codes sont rangés par fonction, un dossier pour les codes d'évitement d'obstacle, pour le contrôle de la base roulante, ... Une fois que les codes fonctionnent indépendamment, on classerra par carte.

Les rêgles de code :

1. Utilisez la prgrammation orientée objet
2. Utilisez une machine d'état
3. Commentez le code
4. Faire des commits et des pushs réguliers
5. N'hésitez pas à créer des branches pour des nouvelles fonctionnalités
6. Faites des pull requests pour fusionner les branches, ne jamais push directement sur la branche principale

Les conventions de nommage :

• Les noms de fichiers doivent être en minuscule et séparés par des _
• Les noms de classes doivent être en PascalCase (majuscule au début de chaque mot)
• Les noms de méthodes doivent être en camelCase (majuscule au début de chaque mot sauf le premier)
• Les noms de variables doivent être en camelCase
• Les noms des constantes doivent être en ALL_CAPS (majuscule et séparés par des _)
• Les noms des packages doivent être en minuscule
• Les noms des branches doivent être en minuscule et séparés par des -
• Essayez de donner des noms explicites à vos variables, méthodes, classes, ... (en anglais si vous êtes deter)