Skip to content

Commit 32293df

Browse files
committed
Land rapid7#3277 - Be very clear about Redmine's existence
2 parents c4d4af0 + fe86886 commit 32293df

File tree

1 file changed

+22
-7
lines changed

1 file changed

+22
-7
lines changed

CONTRIBUTING.md

Lines changed: 22 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,29 @@
1-
# Contributing to Metasploit
1+
# Hello, World!
22

33
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.
722

823
If you care not to follow these rules, your contribution **will** be
924
closed (*Road House* style). Sorry!
1025

11-
Incidentally, this is a **short** list. The
26+
This is intended to be a **short** list. The
1227
[wiki](https://github.com/rapid7/metasploit-framework/wiki) is much more
1328
exhaustive and reveals many mysteries. If you read nothing else, take a
1429
look at the standard [development environment setup
@@ -52,8 +67,8 @@ Pull requests [#2940](https://github.com/rapid7/metasploit-framework/pull/2940)
5267

5368
## Bug Reports
5469

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.
5772
* **Do** write a detailed description of your bug and use a descriptive title.
5873
* **Do** include reproduction steps, stack traces, and anything else that might help us verify and fix your bug.
5974
* **Don't** file duplicate reports - search for your bug before filing a new report.

0 commit comments

Comments
 (0)