You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Please try to be as specific as you can about your problem, include steps
10
+
to reproduce (cut and paste from your console output if it's helpful), and
11
+
what you were expecting to happen.
12
+
13
+
Are you about to report a security vulnerability in Metasploit itself?
14
+
How ironic! Please take a look at Rapid7's [Vulnerability
15
+
Disclosure Policy](https://www.rapid7.com/disclosure.jsp), and send
16
+
your report to security@rapid7.com using [our PGP key](http://pgp.mit.edu:11371/pks/lookup?op=vindex&search=0x2380F85B8AD4DB8D).
17
+
18
+
Are you about to contribute some new functionality, a bug fix, or a new
19
+
Metasploit module? If so, read on...
20
+
21
+
# Contributing to Metasploit
22
+
23
+
What you see here in CONTRIBUTING.md is a bullet-point list of the do's
24
+
and don'ts of how to make sure *your* valuable contributions actually
25
+
make it into Metasploit's master branch.
7
26
8
27
If you care not to follow these rules, your contribution **will** be
9
28
closed (*Road House* style). Sorry!
10
29
11
-
Incidentally, this is a **short** list. The
30
+
This is intended to be a **short** list. The
12
31
[wiki](https://github.com/rapid7/metasploit-framework/wiki) is much more
13
32
exhaustive and reveals many mysteries. If you read nothing else, take a
14
33
look at the standard [development environment setup
@@ -18,7 +37,10 @@ and Metasploit's [Common Coding Mistakes](https://github.com/rapid7/metasploit-f
18
37
## Code Contributions
19
38
20
39
***Do** stick to the [Ruby style guide](https://github.com/bbatsov/ruby-style-guide).
40
+
***Do** get [Rubocop](https://rubygems.org/search?query=rubocop) relatively quiet against the code you are adding or modifying.
21
41
***Do** follow the [50/72 rule](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) for Git commit messages.
42
+
***Don't** use the default merge messages when merging from other
43
+
branches.
22
44
***Do** create a [topic branch](http://git-scm.com/book/en/Git-Branching-Branching-Workflows#Topic-Branches) to work on instead of working directly on `master`.
***Do** run `tools/msftidy.rb` against your module and fix any errors or warnings that come up. Even better would be to set up `msftidy.rb` as a [pre-commit hook](https://github.com/rapid7/metasploit-framework/blob/master/tools/dev/pre-commit-hook.rb).
38
-
***Do** use the [many module mixin APIs](https://dev.metasploit.com/documents/api/). Wheel improvements are welcome; wheel reinventions, not so much.
60
+
***Do** use the [many module mixin APIs](https://dev.metasploit.com/api/). Wheel improvements are welcome; wheel reinventions, not so much.
39
61
***Don't** include more than one module per pull request.
***Do** include reproduction steps in the form of verification steps.
51
-
***Do** include a link to the corresponding [Redmine](https://dev.metasploit.com/redmine/projects/framework) issue in the format of `SeeRM #1234` in your commit description.
73
+
***Do** include a link to any corresponding [Issue](https://github.com/rapid7/metasploit-framework/issues)in the format of `See #1234` in your commit description.
52
74
53
75
## Bug Reports
54
76
55
-
***Do** report vulnerabilities in Rapid7 software to security@rapid7.com.
56
-
***Do** create a Redmine account and report your bug there.
77
+
***Do** report vulnerabilities in Rapid7 software directly to security@rapid7.com.
57
78
***Do** write a detailed description of your bug and use a descriptive title.
58
79
***Do** include reproduction steps, stack traces, and anything else that might help us verify and fix your bug.
59
80
***Don't** file duplicate reports - search for your bug before filing a new report.
60
-
***Don't** report a bug on GitHub. Use [Redmine](https://dev.metasploit.com/redmine/projects/framework) instead.
61
-
62
-
Redmine issues [#8762](https://dev.metasploit.com/redmine/issues/8762) and [#8764](https://dev.metasploit.com/redmine/issues/8764) are a couple good examples to follow.
63
81
64
82
If you need some more guidance, talk to the main body of open
65
83
source contributors over on the [Freenode IRC channel](http://webchat.freenode.net/?channels=%23metasploit&uio=d4)
0 commit comments