Contribuer au code

Apporter des modifications au code d’OSRD

Ce chapitre décrit le processus aboutissant à l’intégration de code au sein du projet. Si vous avez besoin d’aide, ouvrez une issue ou envoyez un message instantané.

L’application OSRD est divisée en plusieurs services écrits dans plusieurs langues. Nous essayons de suivre les bonnes pratiques générales en matière de code et de respecter les spécificités de chaque langage lorsque cela est nécessaire.


Principes généraux

À lire en premier !

Conventions back-end

Conventions de codes et bonnes pratiques pour le back-end

Conventions front-end

Conventions de codes et bonnes pratiques pour le front-end

Écrire du code

Apporter des modifications au code d’OSRD

Style des commits

Quelques bonnes pratiques et règles pour les messages de commits

Partagez vos changements

Comment soumettre votre code pour qu’il soit vérifié ?

Tests

Recommandations pour les tests