Developer Guidelines

From SleuthKitWiki
Revision as of 09:52, 13 June 2012 by Wikiadmin (Talk | contribs)

Jump to: navigation, search

This page contains the guidelines for developing code for The Sleuth Kit and Autopsy. These guidelines are not about the technical designs of the tools, rather they are about how code is contributed and merged in. Note that this document is a work in progress as the process is officially defined.


The Sleuth Kit Developers e-mail list is the official communication forum for TSK and Autopsy development. Subscribe to participate in the development process.

There are also trackers on SourceForge and github to keep track of bugs and feature requests.

Submitting Patches / Code

All of the development is now done from our github projects. To submit code to one of the projects, you will need to create a pull request. The previously linked to page outlines how to generate a pull request, but the high-level overview is to:

  • Create a github account
  • Create a fork of sleuthkit, Autopsy, or another project into your account
  • Make changes to the code in your fork
  • Create a pull request

The patches and code contributions will be reviewed and incorporated into the main development if they are approved. It is also helpful to submit test images and test cases that can be used to test the new code.

Code submissions should follow the error handling, Unicode, and other conventions of the specific tool. A more detailed list of tool-specific guidelines is being developed.

Code Acceptance

Currently, these tools have a Benevolent Dictator model for incorporating code into the official distribution. As more developers get involved, this can change. Acceptance is based on code quality and completeness.