Skip to content

Commit b321f72

Browse files
committed
Land rapid7#6958, Modify contributing.md to require module docs with new modules
2 parents f7d2615 + 68fdeb6 commit b321f72

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

CONTRIBUTING.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,10 @@ Pull requests [PR#2940] and [PR#3043] are a couple good examples to follow.
5656
- It would be even better to set up `msftidy.rb` as a [pre-commit hook].
5757
* **Do** use the many module mixin [API]s. Wheel improvements are welcome; wheel reinventions, not so much.
5858
* **Don't** include more than one module per pull request.
59+
* **Do** include instructions on how to setup the vulnerable environment or software
60+
* **Do** include [Module Documentation](https://github.com/rapid7/metasploit-framework/wiki/Generating-Module-Documentation) showing sample run-throughs
61+
62+
5963

6064
#### Scripts
6165

0 commit comments

Comments
 (0)