Contributing¶
Remo.TV is an open source project. That means that the code is available for free, and that anybody can contribute to it. We’re always happy to have new contributors even if it’s as simple as fixing a spelling error.
We also discuss our code often on Discord, so come check it out!
Robot Controller¶
The robot controller code is written in Python. There’s legacy support for Python 2, but all new code is written for Python 3 as Python 2 is deprecated.
Filing a bug report¶
With a GitHub account, you can submit a bug report if you’ve found something that doesn’t behave as it should, or even just a typo! We have a template that you can/should follow.
Website Code¶
The website itself is split into two GitHub repositories; the front end and the back end. Because of this, it’s much easier for us to discuss issue reports and feature requests on Discord, linked above.
Changing the code yourself¶
We welcome anybody who wants to contribute their own code to the controller. For safety purposes, we don’t allow people to push their code directly to the repository. Instead, you can follow these instructions:
- Fork the repository. That copies our controller into a repository that you can write to. You can clone it to your own computer or edit it straight on GitHub.
- Make your changes. Don’t forget to commit and push to your forked repo.
- Make a pull request. We’ll discuss it and if we decide that it’s something that would be beneficial, we’ll merge it and your code will be part of everyone’s robots!
If you do choose to contribute, we ask that you follow conventional coding practices regarding variable naming, syntax structure, et. cetera.
The person who writes the technical documentation wishes to request that any code you add comes with the relevant in-code documentation (JSDoc for JavaScript, Javadoc for Java/Kotlin, and docstrings for Python).