Skip to content
This repository has been archived by the owner on Aug 25, 2020. It is now read-only.

Contributing

danbim edited this page Jul 20, 2011 · 3 revisions

Great to hear you're interested in contributing! Contributing is very easy. All you need is a valid github account and you're ready to go.

Contributing Documentation

If you want to improve, fix or enhance the documentation please simply edit the according Wiki page. If you want you may drop a short note to Daniel Bimschas.

Contributing Code

Forking

If you want to contribute code the easiest thing is to fork the project to your own account, then commit and push your contribution to your fork and send a pull request afterwards. This is the preferred way for contributions as we can take a second look at your code.

Pushing to the Main Repository

If you want push privileges to the main repository ([email protected]:itm/testbed-runtime.git) please contact Daniel Bimschas to add you as a committer.

Where Can I Find What?

Over time we streamlined and are still in the process of streamlining the Testbed Runtime code base. This means that we already swapped out several parts of the code base to their own individual top level project. This may have hapened due to the fact that it simply makes sense to have develop these artifacts independently from Testbed Runtime or to avoid circular dependencies. As of the time of writing this, Testbed Runtime uses several self-developments in other top level projects such as:

Project Description
wsn-device-drivers A Java-based implementation of device drivers based on the RXTX library to connect the Testbed Runtime system to sensor nodes.
wsn-device-utils Various utilities that basically wrap the wsn-device-drivers to provide both CLI clients and even more easy-to-use libraries for common functionalities.
itm-utils A general collection of utility classes used in various projects
netty-handlerstack A collection of WSN protocol handlers and libraries based on JBoss Netty to support the implementation of various Testbed Runtime features.
netty-iostream Support for the usage of general I/O-Streams in JBoss Netty.

As Testbed Runtime is Maven based, we make sure that all dependencies are available as Maven artifacts, too. Actually, the projects listed above are all Maven based too which greatly simplifies the development process.