First Contribution Ideas

Christopher Peplin edited this page Aug 30, 2014 · 10 revisions

This page is a collection of good places to start with a contribution to OpenXC - fixing small bugs, typos, improving the documentation, etc.

Website

Find any mistakes or unclear sections on the OpenXC website? Want to add another section? Make your changes in the web site repository and send a pull request. The tools you'll learn are Git, Jekyll, Markdown, and possibly some HTML/CSS.

Software

Vehicle Interface Firmware

Good at embedded computing? Know C or C++? The vehicle interface firmware could use some love.

Check out the Kanban board of issues for vi-firmware to see which are ready to tackle.

If you're working through the documentation and think it could be explained better, or you found a peculiar bug in your setup that you want to help someone else avoid, why not make the change yourself? The documentation for the VI is all in the repository. The tools you'll learn by making a change are Git, reStructuredText, and the Sphinx documentation engine.

Android Library

An Android expert? Love Java? See what you can improve in the Android library.

Check out the Kanban board of issues for openxc-and to see which are ready to tackle.

The example Android app (the vehicle dashboard is pretty plain - it's just a list of text fields with vehicle data. See what you can do to make it more visually interesting or useful! The tools you'll learn are Git, Android and you'll pick up some UI design skills.

The developer documentation for the library is a part of the OpenXC website. If you find anything that could be improved or fixed, you can make changes and submit pull requests

Web Apps

If you love graphs, why not improve the vehicle data trace visualization? The tools you'll learn are Git, HTML/CSS, and JavaScript.

Python Library

A die-hard Pythonista? Help out with the Python library.

Check out the Kanban board of issues for openxc-python to see which are ready to tackle.

If you have issues with installation and the documentation doesn't help, why not improve it? The docs are all hosted in the openxc-python repository. Send a pull request with your changes. The tools you'll learn are Git, reStructuredText, the Sphinx documentation engine and Python.

Hardware

If you're working through the chipKIT VI assembly instructions and think it could be explained better, or you found a peculiar bug in your setup that you want to help someone else avoid, why not make the change yourself? Fork the web site repository and send a pull request with your changes. The tools you'll learn are Git, Jekyll, Markdown, and possibly some HTML/CSS.

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.