Grant Willcox gwillcox-r7

Since we've had a few questions about contributing here I thought I'd throw up a quick reference guide that people can refer to. The following are some links to help you get started with contributing to Metasploit:

Read over https://docs.metasploit.com/docs/development/get-started/. Particularly the parts on https://docs.metasploit.com/docs/development/get-started/setting-up-a-metasploit-development-environment.html for how to set up your Metasploit development environment and https://docs.metasploit.com/docs/development/get-started/creating-your-first-pr.html for how to make your first PR contribution.
When you are starting off looking for issues to work on, take a look for the #easy or #newbie-friendly tags using https://github.com/rapid7/metasploit-framework/issues?q=is%3Aissue+is%3Aopen+label%3Aeasy and https://github.com/rapid7/metasploit-framework/issues?q=is%3Aissue+is%3Aopen+label%3Anewbie-friendly respectively. These issues have been specifically listed as being easier to start working on.

VSCode Workflow For Metasploit Development

References

https://northsail.io/articles/lean-ruby-ide-switching-from-rubymine-to-vscode <- First reference I used, contains good info on Plugins but not so much on how to configure them.
https://achris.me/blog/enchant_ruby_vscode <- More detailed information on plugins and why they are useful. Helped elevate things more and explain why some plugins are important.

Plugins

Essential

Ruby

Basis for literally everything else here. Provides the Ruby language support and debugging support for Ruby programs, code folding support, semantic highlighting support, basic intellisense support, and automatic Ruby environment support which is essential if your a developer with multiple Ruby versions like me.

Keybase proof

I hereby claim:

I am gwillcox-r7 on github.
I am grantwillcox (https://keybase.io/grantwillcox) on keybase.
I have a public key ASCfko3H39lpsdql8Y6aXZFvm6PFlpoMwV1sOZD8lkPGugo

To claim this, I am signing this object:

	[user]
	name = Grant Willcox
	email = [email protected]
	signingkey = 3198961E148FF5E527E31A5FD35E05C0F2B81E83
	[commit]
	gpgsign = true
	[core]
	repositoryformatversion = 0
	filemode = true
	bare = false

	---
	include:
	- "*/.rb"
	exclude:
	- spec/*/
	- test/*/
	- vendor/*/
	- ".bundle/*/"
	- data/*/
	- db/*/

	#!/bin/bash
	# Generate the raw YARD stats on undocumented
	yard stats -q --list-undoc --compact > undocumented-api.txt

	# Strip out the statistics at the top of the output. For some reason --no-stats doesn't seem to stop this being printed.
	pcregrep -Mv "[\w\W]+Undocumented Objects:" undocumented-api.txt > filtered1-undocumented-api.txt

	# Turn the file names into links to the equivalent GitHub Pages
	sed 's/(/https:\/\/github\.com\/rapid7\/metasploit-framework\/blob\/master\//' filtered1-undocumented-api.txt > filtered2-undocumented-api.txt

	# Taken from https://github.com/itm4n/CVEs/blob/master/CVE-2020-1170/DefenderArbitraryFileDelete.ps1 with minor modifications made where needed for Metasploit.
	# All credits go to @itm4n for this PowerShell script!

	# Testing
	# powershell -ep bypass -c ". .\DefenderArbitraryFileDelete.ps1; DoMain -TargetFolder 'C:\ZZ_SANDBOX\WER'"
	# Real
	# powershell -ep bypass -c ". .\DefenderArbitraryFileDelete.ps1; DoMain -TargetFolder 'C:\ProgramData\Microsoft\Windows\WER'

	$JobCode = {
	function DoMpCmdRunLogFileWriteTriggerJob {