Skip to content

Commit 2861b70

Browse files
author
Tod Beardsley
committed
Add a note about hooking msftidy
1 parent 75d6c80 commit 2861b70

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,3 +36,9 @@ Pull requests tend to be very collaborative for Metasploit -- do not be
3636
surprised if your pull request to rapid7/metasploit-framework triggers a
3737
pull request back to your own fork. In this way, we can isolate working
3838
changes before landing your PR to the Metasploit master branch.
39+
40+
To save yourself the embarrassment of committing common errors, you will
41+
want to symlink the `msftidy.rb` utility to your pre-commit hooks by
42+
running `ln -s ../../tools/dev/pre-commit-hook.rb .git/hooks/pre-commit`
43+
from the top-level directory of your metasploit-framework clone. This
44+
will prevent you from committing modules that raise WARNINGS or ERRORS.

0 commit comments

Comments
 (0)