Skip to content

Latest commit

 

History

History
40 lines (27 loc) · 1.79 KB

CONTRIBUTING.md

File metadata and controls

40 lines (27 loc) · 1.79 KB

Contributing to OSRD

All contributions, bug reports, bug fixes, documentation improvements, enhancements, and ideas are welcome.

Check out our community's Code of Conduct and feel free to say hi on our #public-general:osrd.fr matrix channel if you'd like. It's a nice place to chat about OSRD development, ask questions, and get to know the other contributors and users in a less formal setting. If you are not sure about what to do, have a look at currently open good first issues.

Getting oriented

The OSRD project has 2 primary repos:

  1. osrd: This is where the simulator is developed.
  2. osrd-website: Where the official website, blog, documentation, ... are hosted.

This is the ui repo. For more information on the project and how to contribute to it checkout the Contributing file of the main repo.

Contribute code

To comply with the DCO, all commits must include a Signed-off-by line. You can find more information about this here.

For more advice on how to contribute, follow that link: https://osrd.fr/en/docs/guides/contribute/contribute-code

Pull request / code review

https://osrd.fr/en/docs/guides/contribute/code/#share-your-changes

Report and solve bugs

https://osrd.fr/en/docs/guides/contribute/bug-reports