2012-11-07 02:18:58 +00:00
# Contributing to Metasploit
## Reporting Bugs
If you would like to report a bug, please take a look at [our Redmine
issue
tracker](https://dev.metasploit.com/redmine/projects/framework/issues?query_id=420)
2012-11-13 17:21:58 +00:00
-- your bug may already have been reported there! Simply [searching ](https://dev.metasploit.com/redmine/projects/framework/search ) for some appropriate keywords may save everyone a lot of hassle.
2012-11-07 02:18:58 +00:00
If your bug is new and you'd like to report it you will need to
[register
first](https://dev.metasploit.com/redmine/account/register). Don't
worry, it's easy and fun and takes about 30 seconds.
2013-05-10 20:15:29 +00:00
When you file a bug report, please include your **steps to reproduce** ,
2012-12-21 15:48:13 +00:00
full copy-pastes of Ruby stack traces, and any relevant details about
your environment. Without repro steps, your bug will likely be closed.
With repro steps, your bugs will likely be fixed.
2012-11-13 17:21:58 +00:00
## Contributing Metasploit Modules
2012-11-07 02:18:58 +00:00
If you have an exploit that you'd like to contribute to the Metasploit
Framework, please familiarize yourself with the
2012-11-19 17:20:40 +00:00
**[HACKING](https://github.com/rapid7/metasploit-framework/blob/master/HACKING)**
2012-11-07 02:18:58 +00:00
document in the
Metasploit-Framework repository. There are many mysteries revealed in
HACKING concerning code style and content.
[Pull requests ](https://github.com/rapid7/metasploit-framework/pulls )
should corellate with modules at a 1:1 ratio
-- there is rarely a good reason to have two, three, or ten modules on
one pull request, as this dramatically increases the review time
required to land (commit) any of those modules.
Pull requests tend to be very collaborative for Metasploit -- do not be
surprised if your pull request to rapid7/metasploit-framework triggers a
pull request back to your own fork. In this way, we can isolate working
changes before landing your PR to the Metasploit master branch.
2013-05-28 15:44:23 +00:00
To save yourself the embarrassment of committing common errors, you will
want to symlink the `msftidy.rb` utility to your pre-commit hooks by
running `ln -s ../../tools/dev/pre-commit-hook.rb .git/hooks/pre-commit`
from the top-level directory of your metasploit-framework clone. This
will prevent you from committing modules that raise WARNINGS or ERRORS.
