From 68fdeb603196b888ee9c742d454d17395094f7c2 Mon Sep 17 00:00:00 2001 From: Brent Cook Date: Thu, 9 Jun 2016 15:23:32 -0500 Subject: [PATCH] suggest that we should include module docs and links to vuln software --- CONTRIBUTING.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c9ccb13e26..b27245c6f4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -56,6 +56,10 @@ Pull requests [PR#2940] and [PR#3043] are a couple good examples to follow. - It would be even better to set up `msftidy.rb` as a [pre-commit hook]. * **Do** use the many module mixin [API]s. Wheel improvements are welcome; wheel reinventions, not so much. * **Don't** include more than one module per pull request. +* **Do** include instructions on how to setup the vulnerable environment or software +* **Do** include [Module Documentation](https://github.com/rapid7/metasploit-framework/wiki/Generating-Module-Documentation) showing sample run-throughs + + #### Scripts