Hacker's Guide to dradis

If you are contributing code to the dradis Framework project, please read this first.

[ Note: there is lots to be added here regarding system design, architecture, dependencies, coding style, etc. The main reference creating this page has been: Hacker's Guide to Subversion. ]

Table of Contents

• Participating in the community
• Subversion repository: Everything you need to know

Participating in the community

dradis is an open-source project published under a GPL v2.0 license.

The community exists mainly through mailing lists, a user forum and a Subversion repository. To participate:

• Join the dradis-devel and dradis-svn mailing lists.

  The devel list is where almost all discussion takes place. All development questions should go there, though you might want to check the list archives first. The svn list receives automated commit emails.

• Get a copy of the latest development sources from the repository.

  New development always takes place on trunk/. Bugfixes, enhancements, and new features are backported from there to the various release branches.

There are many ways to join the project, either by writing code, or by testing and/or helping to manage the bug database. If you'd like to contribute, then look at:

• The feature requests and the bug tracker.
• The roadmap which contains some of the forthcoming features to be implemented.

To submit code, simply send your patches to dradis-devel[-the-symbol-]lists.sourceforge.net.

back to top

Subversion repository: Everything you need to know

The truth is that everything you need to know about the repository is captured in the README.svn file. However, there here are a few useful tips:

• The repository is broken down in modules for the different Dradis components:
  • client: Console interface and wxWidgets GUI.
  • installer: Installer packages for different OS.
  • launcher: Helper application to configure and launch the dradis components.
  • meta: Meta-information: license, release notes, README files, etc.
  • server: Ruby on Rails REST-enabled web application
• If you want to learn how to work with the latest development release, read this.
• We try to follow a Branch-When-Needed system.
• Disruptive functionality and experimental branches are developed inside branches/experimental/.

back to top