Need to do this. Should not only have ideas and tasks, but also split into Pre/During/

Create a document describing how users can contribute to RobotPy about robotpy-docs HOT 1 OPEN

robotpy commented on August 15, 2024

Create a document describing how users can contribute to RobotPy

from robotpy-docs.

Comments (1)

virtuald commented on August 15, 2024

Thoughts I DM'ed to someone:

RobotPy intends to be a project that anyone can contribute to. Unfortunately, with the move to C++ bindings, the 'how to contribute' has become much less obvious. In fact, one of my personal TODOs this season was to add a section to the docs explaining to interested people how they can contribute... but I haven't actually taken the time to do it yet. Maybe this weekend. Created a github issue here -- #48

In general, the most important thing anyone could contribute is to find things that annoy you about RobotPy, and then go about fixing them. If it's not obvious how to fix them, then post questions at https://gitter.im/robotpy/robotpy-wpilib or on CD.

If there aren't things that annoy you, anytime that I run into something that annoys me I try to post a github issue if I can't immediately fix it. In particular, there are a few installer issues that might be easy for others to work on: https://github.com/robotpy/robotpy-installer/issues

Two easy things that come immediately to mind:

Porting existing vendor and wpilib examples to RobotPy

Improving and adding documentation to RobotPy

It is possible that we will add python examples to frc-docs this upcoming season -- in which case, that would also be a lot of work that would require help. Still need to have some discussions and open an initial PR proposing this.

There is a lot of challenging C++/pybind11 work as well, some of which are referenced here: https://github.com/orgs/robotpy/projects/8. Upgrading RobotPy for the upcoming season involves a lot of this sort of work, but really can't be done until the WPILib betas come out.