Contributing

What needs to be done needs to be done

There are diverse ways to contribute as there are diverse issues that have to be handled during software development. Since the splonebox ought to be a tool based on plugins, everything comes and falls with them. So if you think, there is a cool feature missing, a plugin might be great way to implement it.

• Plugins: Although the core is an import part of the splonebox, the plugins do the main work. In order to extend functionality, more plugins are needed. A typical plugin might do:
  • active network reconnaissance
  • passive network reconnaissance
  • graphical user interface
  • ..
• Code Review: If you like reading code, feel free to read the splonebox code. If you find bugs, please create an issue.
• Testing: Sometimes it is easier to start participating by writing some test code. So if you like testing code and finding bugs, you can improve existing unit & function tests or even write new ones.
• Documentary: Often documentation is done in a poor fashion. If you read into the code and got an idea of what is happening, then consider documenting it. There a two major ways to document: doxygen and wiki. In order to document our code inline, we use doxygen. With doxygen it's possible to generate a wide variety of output formats which is very helpful. The other way is to fill the wiki. The wiki is typically more story telling and descriptive.