|
1 |
| -# Contributing to Metasploit |
| 1 | +# Hello, World! |
2 | 2 |
|
3 | 3 | Thanks for your interest in making Metasploit -- and therefore, the
|
4 |
| -world -- a better place! What you see here in CONTRIBUTING.md is a |
5 |
| -bullet-point list of the do's and don'ts of how to make sure *your* |
6 |
| -valuable contributions actually make it into Metasploit's master branch. |
| 4 | +world -- a better place! |
| 5 | + |
| 6 | +Are you about to report a bug? If so, please use our [Redmine Bug |
| 7 | +Tracker](https://dev.metasploit.com/redmine/projects/framework). An |
| 8 | +account is required but it only takes a minute or two. |
| 9 | + |
| 10 | +Are you about to report a security vulnerability in Metasploit? |
| 11 | +If so, please take a look at Rapid's [Vulnerability |
| 12 | +Disclosure Policy](https://www.rapid7.com/disclosure.jsp) policy. |
| 13 | + |
| 14 | +Are you about to contribute some new functionality, a bug fix, or a new |
| 15 | +Metasploit module? If so, read on... |
| 16 | + |
| 17 | +# Contributing to Metasploit |
| 18 | + |
| 19 | +What you see here in CONTRIBUTING.md is a bullet-point list of the do's |
| 20 | +and don'ts of how to make sure *your* valuable contributions actually |
| 21 | +make it into Metasploit's master branch. |
7 | 22 |
|
8 | 23 | If you care not to follow these rules, your contribution **will** be
|
9 | 24 | closed (*Road House* style). Sorry!
|
10 | 25 |
|
11 |
| -Incidentally, this is a **short** list. The |
| 26 | +This is intended to be a **short** list. The |
12 | 27 | [wiki](https://github.com/rapid7/metasploit-framework/wiki) is much more
|
13 | 28 | exhaustive and reveals many mysteries. If you read nothing else, take a
|
14 | 29 | look at the standard [development environment setup
|
@@ -52,8 +67,8 @@ Pull requests [#2940](https://github.com/rapid7/metasploit-framework/pull/2940)
|
52 | 67 |
|
53 | 68 | ## Bug Reports
|
54 | 69 |
|
55 |
| -* **Do ** report vulnerabilities in Rapid7 software to [email protected]. |
56 |
| -* **Do** create a Redmine account and report your bug there. |
| 70 | +* **Do ** report vulnerabilities in Rapid7 software directly to [email protected]. |
| 71 | +* **Do** create a Redmine account and report your non-vulnerability bugs there. |
57 | 72 | * **Do** write a detailed description of your bug and use a descriptive title.
|
58 | 73 | * **Do** include reproduction steps, stack traces, and anything else that might help us verify and fix your bug.
|
59 | 74 | * **Don't** file duplicate reports - search for your bug before filing a new report.
|
|
0 commit comments