General principles
Please read this first!
Contribute code
Integrate changes into OSRD
This chapter is about the process of integrating changes into the common code base. If you need help at any stage, open an issue or message us.
OSRD application is split in multiple services written in several languages. We try to follow general code best practices and follow each language specificities when required.
Back-end conventions
Coding style guide and best practices for back-end
Front-end conventions
Coding style guide and best practices for front-end
Write code
Integrate changes into OSRD
Commit conventions
A few advises and rules about commit messages
Share your changes
How to submit your code modifications for review?
Tests
Recommandations for testing purpose