HACKING

HACKING
=======

(Last updated: 2014-03-04)

This document almost entirely deprecated by:

CONTRIBUTING.md

in the same directory as this file, and to a lesser extent:

The Metasploit Development Environment
https://github.com/rapid7/metasploit-framework/wiki/Setting-Up-a-Metasploit-Development-Environment

Common Coding Mistakes
https://github.com/rapid7/metasploit-framework/wiki/Common-Metasploit-Module-Coding-Mistakes

The Ruby Style Guide
https://github.com/bbatsov/ruby-style-guide

Ruby 1.9: What to Expect
http://slideshow.rubyforge.org/ruby19.html

You can use the the "./tools/msftidy.rb" script against your new and
changed modules to do some rudimentary checking for various style and
syntax violations.

Licensing for Your New Content
==============================

By submitting code contributions to the Metasploit Project it is
assumed that you are offering your code under the Metasploit License
or similar 3-clause BSD-compatible license.  MIT and Ruby Licenses
are also fine.  We specifically cannot include GPL code. LGPL code
is accepted on a case by case basis for libraries only and is never
accepted for modules.