Skip to content

Introduction

First, let me thank you personnaly for your interest in our project and your desire to contribute to OpenRAMAN. It is from individual like you that our project will be able to grow to achieve its full potential. Thank you

You may contribute to the project in different manner:

  • By fixing a bug, inconsistency or specific issue in either the hardware, the software or the documentation,
  • By proposing new features in either the hardware or software,
  • By helping maintainers to review pending contributions.

Not all changes need hundred of hours of your time, but, in all case we ask you to put your best efforts in doing the best job you can when submitting a change. We require all changes to be at the best technical proficiency, and to provide proofs of the claims they aim to achieve.

Also, changes need to be reviewed by our maintainer team who do this tedious process free of charge. We therefore ask you to treat them with the respect they deserve. Be patient and do not be offended if your change is not accepted at first submission. In the event your change would be rejected, analyze the feedback of the maintainers and consider re-submitting your work once you believe you have adressed the sour spot.

The following sections will guide you on how to set up your working environment and obtain a copy of the source files, the preferred toolchain you can use to implement your changes, how the submission process works, and how to properly license your work to fit into the project.