@@ -4,8 +4,8 @@ Thanks for your interest in making Metasploit -- and therefore, the
4
4
world -- a better place!
5
5
6
6
Are you about to report a bug? Sorry to hear it. Here's our [ Issue tracker] .
7
- Please try to be as specific as you can about your problem, include steps
8
- to reproduce (cut and paste from your console output if it's helpful), and
7
+ Please try to be as specific as you can about your problem; include steps
8
+ to reproduce (cut and paste from your console output if it's helpful) and
9
9
what you were expecting to happen.
10
10
11
11
Are you about to report a security vulnerability in Metasploit itself?
@@ -18,7 +18,7 @@ Metasploit module? If so, read on...
18
18
19
19
# Contributing to Metasploit
20
20
21
- What you see here in CONTRIBUTING.md is a bullet- point list of the do's
21
+ What you see here in CONTRIBUTING.md is a bullet point list of the do's
22
22
and don'ts of how to make sure * your* valuable contributions actually
23
23
make it into Metasploit's master branch.
24
24
@@ -27,7 +27,7 @@ closed. Sorry!
27
27
28
28
This is intended to be a ** short** list. The [ wiki] is much more
29
29
exhaustive and reveals many mysteries. If you read nothing else, take a
30
- look at the standard [ development environment setup] guide,
30
+ look at the standard [ development environment setup] guide
31
31
and Metasploit's [ Common Coding Mistakes] .
32
32
33
33
## Code Contributions
@@ -52,7 +52,7 @@ Pull requests [PR#2940] and [PR#3043] are a couple good examples to follow.
52
52
#### New Modules
53
53
54
54
* ** Do** run ` tools/msftidy.rb ` against your module and fix any errors or warnings that come up.
55
- - Even better would be to set up ` msftidy.rb ` as a [ pre-commit hook] .
55
+ - It would be even better to set up ` msftidy.rb ` as a [ pre-commit hook] .
56
56
* ** Do** use the many module mixin [ API] s. Wheel improvements are welcome; wheel reinventions, not so much.
57
57
* ** Don't** include more than one module per pull request.
58
58
@@ -80,19 +80,19 @@ Pull requests [PR#2940] and [PR#3043] are a couple good examples to follow.
80
80
* ** Do
** report vulnerabilities in Rapid7 software directly to
[email protected] .
81
81
* ** Do** write a detailed description of your bug and use a descriptive title.
82
82
* ** Do** include reproduction steps, stack traces, and anything else that might help us verify and fix your bug.
83
- * ** Don't** file duplicate reports - search for your bug before filing a new report.
83
+ * ** Don't** file duplicate reports; search for your bug before filing a new report.
84
84
85
85
If you need some more guidance, talk to the main body of open
86
- source contributors over on the [ Freenode IRC channel]
87
- or e-mail us at [ metasploit-hackers] mailing list.
86
+ source contributors over on the [ Freenode IRC channel] ,
87
+ or e-mail us at the [ metasploit-hackers] mailing list.
88
88
89
89
Also, ** thank you** for taking the few moments to read this far! You're
90
90
already way ahead of the curve, so keep it up!
91
91
92
92
[ Issue Tracker ] :http://r-7.co/MSF-BUGv1
93
93
[ PGP key ] :http://pgp.mit.edu:11371/pks/lookup?op=vindex&search=0x2380F85B8AD4DB8D
94
94
[ wiki ] :https://github.com/rapid7/metasploit-framework/wiki
95
- [ scripts ] : https://github.com/rapid7/metasploit-framework/tree/master/scripts
95
+ [ scripts ] :https://github.com/rapid7/metasploit-framework/tree/master/scripts
96
96
[ development environment setup ] :http://r-7.co/MSF-DEV
97
97
[ Common Coding Mistakes ] :https://github.com/rapid7/metasploit-framework/wiki/Common-Metasploit-Module-Coding-Mistakes
98
98
[ Ruby style guide ] :https://github.com/bbatsov/ruby-style-guide
@@ -104,10 +104,10 @@ already way ahead of the curve, so keep it up!
104
104
[ PR#2940 ] :https://github.com/rapid7/metasploit-framework/pull/2940
105
105
[ PR#3043 ] :https://github.com/rapid7/metasploit-framework/pull/3043
106
106
[ pre-commit hook ] :https://github.com/rapid7/metasploit-framework/blob/master/tools/dev/pre-commit-hook.rb
107
- [ API ] :https://rapid7.github.io/metasploit-framework/api/
108
- [ RSpec ] :http://rspec.info/
109
- [ Better Specs ] :http://betterspecs.org/
110
- [ YARD ] :http://yardoc.org/
107
+ [ API ] :https://rapid7.github.io/metasploit-framework/api
108
+ [ RSpec ] :http://rspec.info
109
+ [ Better Specs ] :http://betterspecs.org
110
+ [ YARD ] :http://yardoc.org
111
111
[ Issues ] :https://github.com/rapid7/metasploit-framework/issues
112
112
[ Freenode IRC channel ] :http://webchat.freenode.net/?channels=%23metasploit&uio=d4
113
113
[ metasploit-hackers ] :https://lists.sourceforge.net/lists/listinfo/metasploit-hackers
0 commit comments