Get involved

How you can help

Arduino Designer is an open source project and everyone is encouraged to get involved! There are lots of ways you can contribute:

• join the community
• find and report bugs
• write tests for bugs
• improve the documentation
• add new features
• fix bugs
• contact me and give me feedback by email, by twitter, by G+.

Report bugs

Arduino Designer uses GitHub to track issues. Bug reports are really important, so please report any issues you have. When you report bugs, make sure you include lots of detail, reproducible tests, example code or anything else you think might help!

Contribute to the code

Arduino Designer's code and documentation is hosted on Github. It's easy to get the code and build Arduino Designer from source. Just clone our repository, make your changes and send us a pull-request.

To contribute to the code, after cloning the repository just import in your Eclipse all the projects available from the plugins and releng folders. In the releng folder, the project fr.obeo.dsl.arduino.target provides the Target Platform used to develop the Arduino Designer, set it as TP in your workspace. Then all the code is available from the projects in the plugins folder :

• fr.obeo.dsl.arduino defines the Arduino metamodel
• fr.obeo.dsl.arduino.edit EMF edit project from the Arduino metamodel
• fr.obeo.dsl.arduino.editor EMF editor for the Arduino metamodel
• fr.obeo.dsl.arduino.ui defines the simplified toolbar and all the UI available actions
• fr.obeo.dsl.arduino.design defines the Sirius specification model to create the graphical designer (defines available viewpoints and representations, maps the metamodel concepts to graphical elements, and defines the tools available in the palette). The Arduino Designer is developped based on Sirius. It is then really easy to take in hand and to contribute. Have a look to the Get started with Sirius documentation.
• fr.obeo.dsl.arduino.gen defines the Acceleo generators to generate Arduino code from the model -fr.obeo.dsl.arduino.build provides all the tools used to cross-compile and upload the code for the Arduino board.

Contribute to documentation

Manually create a fork of the Arduino Designer wiki on your Github account:

• Create a new repository on your github account. Let's call it "arduino-Wiki".
• Clone the Arduino Designer wiki repo to your local machine somewhere: git clone https://github.com/mbats/arduino.wiki.git
• Remove the original "origin" remote and add your github repo as new "origin" git remote rm origin and git remote add origin git://github.com/<YOUR_USERNAME>/arduino-Wiki.git
• Make your proposed changes locally, then push them to your github account: git push -u origin master ('-u origin master' only required the first time; afterwards just do git push)
• Submit a ticket to the official Arduino Designer issue tracker requesting us to review your changes and merge them in. Please be sure to include a link to your repo and describe what you've changed.