Browse Source

Update CONTRIBUTING.md

Caitlin Condon 10 months ago
parent
commit
16d7c0530a
No account linked to committer's email address
1 changed files with 8 additions and 8 deletions
  1. 8
    8
      CONTRIBUTING.md

+ 8
- 8
CONTRIBUTING.md View File

@@ -2,20 +2,18 @@
2 2
 
3 3
 Thanks for your interest in making Metasploit -- and therefore, the
4 4
 world -- a better place!  Before you get started, review our
5
-[Code of Conduct].  There are mutliple ways to help,
6
-not just writing code:
5
+[Code of Conduct].  There are mutliple ways to help beyond just writing code:
7 6
  - [Submit bugs and feature requests] with detailed information about your issue or idea.
8 7
  - [Help fellow users with open issues] or [help fellow committers test recent pull requests].
9 8
  - [Report a security vulnerability in Metasploit itself] to Rapid7.
10 9
  - Submit an updated or brand new module!  We are always eager for exploits, scanners, and new
11
-   features.  Set up a [development environment], then head over to ExploitDB to look for
12
-   [proof-of-concept exploits] that might make a good module.
10
+   integrations or features. Don't know where to start? Set up a [development environment], then head over to ExploitDB to look for [proof-of-concept exploits] that might make a good module.
13 11
 
14 12
 # Contributing to Metasploit
15 13
 
16 14
 Here's a short list of do's and don'ts to make sure *your* valuable contributions actually make
17
-it into Metasploit's master branch.  If you care not to follow these rules, your contribution
18
-**will** be closed.  Sorry!
15
+it into Metasploit's master branch.  If you do not care to follow these rules, your contribution
16
+**will** be closed. Sorry!
19 17
 
20 18
 ## Code Contributions
21 19
 
@@ -36,7 +34,7 @@ it into Metasploit's master branch.  If you care not to follow these rules, your
36 34
 * **Don't** leave your pull request description blank.
37 35
 * **Don't** abandon your pull request. Being responsive helps us land your code faster.
38 36
 
39
-Pull requests [PR#9966] is a couple good examples to follow.
37
+Pull request [PR#9966] is a good example to follow.
40 38
 
41 39
 #### New Modules
42 40
 
@@ -62,7 +60,9 @@ Pull requests [PR#9966] is a couple good examples to follow.
62 60
 
63 61
 ## Bug Reports
64 62
 
65
-* **Do** report vulnerabilities in Rapid7 software directly to security@rapid7.com.
63
+Please report vulnerabilities in Rapid7 software directly to security@rapid7.com. For more on our disclosure policy and Rapid7's approach to coordinated disclosure, [head over here](https://www.rapid7.com/security). 
64
+
65
+When reporting Metasploit issues:
66 66
 * **Do** write a detailed description of your bug and use a descriptive title.
67 67
 * **Do** include reproduction steps, stack traces, and anything that might help us fix your bug.
68 68
 * **Don't** file duplicate reports; search for your bug before filing a new report.

Loading…
Cancel
Save