Skip to content

Latest commit

 

History

History
84 lines (64 loc) · 3.89 KB

contribute.md

File metadata and controls

84 lines (64 loc) · 3.89 KB
Raw
title redirect_from
Contribute
/contributing/index.html
  • Table of Contents {:toc}

ev3dev is a HUGE project and we are always happy to receive help. Here are some of the many ways you can contribute to the project.

Have a look at the "HELP WANTED" issues

We label some issues as HELP WANTED. The means that we could use your feedback, the task is very time consuming or we don't have the hardware needed. Click on the link to see the list of issues and contribute if you can.

Write some documentation

All of our documentation (including this entire website) is maintained through GitHub via pull requests (so you will need a GitHub account if you don't already have one). All of the docs pages have a link that says "Edit on Github". Just follow the link and make your changes - and be sure to preview before saving changes. Github will automatically create a pull request. We will review your changes before incorporating them into the site.

Even if a page doesn't have the edit link, you can actually still make changes. Just find it here.

We are also in the process of migrating the wiki documentation to this site. It would be nice to get some help with this. There are just a few pages left that need to be migrated. Pick one, copy it and go through it to make sure links works and the information is still relevant.

Write some software

As the hardware drivers are being finalized, development will be shifting to software that can interface with the hardware. There are many packages on GitHub that you can hack on. Additionally, there are some language bindings listed on the home page that are not part of the ev3dev GitHub organization (yet).

If you have never used GitHub before, it's super-easy. Read about it, then send a pull request.

Write a driver

Have some sensor that isn't supported yet? With a little technical know-how and the right attitude, there is nothing stopping you. Open an issue on GitHub and we can help you get started. For an example of just how easy it can be to add a sensor, check out this commit.

Some things you will need:

  • The actual hardware (sensor or other device).
  • Technical documentation on the hardware that explains the low level communications (or circuit diagram for analog sensors).
  • A computer or virtual machine running Ubuntu 14.04. (Other Linux distros are OK, but this is what we officially support.)
  • An EV3 serial port adapter like mindsensors.com EV3 Console Adapter or make your own.
  • A logic analyzer. [ Advertisement: Get 20% off of Logic or Logic16 from Saleae (and @dlech gets $20 credit) ]

Donate hardware

Don't have the time or interest in writing a driver? You can donate the hardware and we will make it work for you. See this blog post from @dlech for more info.