Contribuer à OSRD
Déjà, merci d’avoir pris le temps de contribuer !
Si les sections suivantes forment un guide du contributeur, ce n’est pas pour autant un ensemble de règles strictes. En fait, si vous avez déjà contribué à des gros projets opensource, la suite ne sera pas surprenante. Dans le cas contraire, elle vous sera probablement très utile !
Communiquer
Vous pouvez gagner du temps en discutant de votre projet de contribution avec les autres contributeurs :
- Rejoignez le salon de messagerie instantanée sur IRC à libera.chat#osrd
- Créez une issue pour avoir un endroit un discuter de votre contribution
Se renseigner
Comme dans tout projet, chaque changement se repose sur ce qui a été fait par le passé. Avant d’apporter un changement, renseignez-vous sur l’existant :
- Vous pouvez lire la documentation technique
- Il est préférable de lire le code source de l’application en rapport avec votre projet
- Vous pouvez contacter les derniers développeurs à avoir travaillé sur les zones du code en rapport avec votre projet
Signaler des problèmes
Comment signaler un bug ou suggérer une amélioration
Contribuer du code
Apporter des modifications au code d’OSRD
Conventions
Conventions de codes et bonnes pratiques
Passer du code en revue
Comment faire des retours constructifs