You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
and Metasploit's [Common Coding Mistakes](https://github.com/rapid7/metasploit-framework/wiki/Common-Metasploit-Module-Coding-Mistakes).
30
+
look at the standard [development environment setup] guide,
31
+
and Metasploit's [Common Coding Mistakes].
36
32
37
33
## Code Contributions
38
34
39
-
***Do** stick to the [Ruby style guide](https://github.com/bbatsov/ruby-style-guide).
40
-
***Do** get [Rubocop](https://rubygems.org/search?query=rubocop) relatively quiet against the code you are adding or modifying.
41
-
***Do** follow the [50/72 rule](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) for Git commit messages.
42
-
***Don't** use the default merge messages when merging from other
43
-
branches.
44
-
***Do** create a [topic branch](http://git-scm.com/book/en/Git-Branching-Branching-Workflows#Topic-Branches) to work on instead of working directly on `master`.
35
+
***Do** stick to the [Ruby style guide].
36
+
***Do** get [Rubocop] relatively quiet against the code you are adding or modifying.
37
+
***Do** follow the [50/72 rule] for Git commit messages.
38
+
***Don't** use the default merge messages when merging from other branches.
39
+
***Do** create a [topic branch] to work on instead of working directly on `master`.
45
40
46
41
### Pull Requests
47
42
48
43
***Do** target your pull request to the **master branch**. Not staging, not develop, not release.
49
44
***Do** specify a descriptive title to make searching for your pull request easier.
50
-
***Do** include [console output](https://help.github.com/articles/github-flavored-markdown#fenced-code-blocks), especially for witnessable effects in `msfconsole`.
51
-
***Do** list [verification steps](https://help.github.com/articles/writing-on-github#task-lists) so your code is testable.
45
+
***Do** include [console output], especially for witnessable effects in `msfconsole`.
46
+
***Do** list [verification steps] so your code is testable.
52
47
***Don't** leave your pull request description blank.
53
48
***Don't** abandon your pull request. Being responsive helps us land your code faster.
54
49
55
-
Pull requests [#2940](https://github.com/rapid7/metasploit-framework/pull/2940) and [#3043](https://github.com/rapid7/metasploit-framework/pull/3043) are a couple good examples to follow.
50
+
Pull requests [PR#2940] and [PR#3043] are a couple good examples to follow.
56
51
57
52
#### New Modules
58
53
59
-
***Do** run `tools/msftidy.rb` against your module and fix any errors or warnings that come up. Even better would be to set up `msftidy.rb` as a [pre-commit hook](https://github.com/rapid7/metasploit-framework/blob/master/tools/dev/pre-commit-hook.rb).
60
-
***Do** use the [many module mixin APIs](https://rapid7.github.io/metasploit-framework/api/). Wheel improvements are welcome; wheel reinventions, not so much.
54
+
***Do** run `tools/msftidy.rb` against your module and fix any errors or warnings that come up.
55
+
- Even better would be to set up `msftidy.rb` as a [pre-commit hook].
56
+
***Do** use the many module mixin [API]s. Wheel improvements are welcome; wheel reinventions, not so much.
61
57
***Don't** include more than one module per pull request.
62
58
59
+
#### Scripts
60
+
61
+
***Don't** submit new [scripts]. Scripts are shipped as examples for
62
+
automating local tasks, and anything "serious" can be done with post
63
+
modules and local exploits.
64
+
63
65
#### Library Code
64
66
65
-
***Do** write [RSpec](http://rspec.info/) tests - even the smallest change in library land can thoroughly screw things up.
66
-
***Do** follow [Better Specs](http://betterspecs.org/) - it's like the style guide for specs.
67
-
***Do** write [YARD](http://yardoc.org/) documentation - this makes it easier for people to use your code.
67
+
***Do** write [RSpec] tests - even the smallest change in library land can thoroughly screw things up.
68
+
***Do** follow [Better Specs] - it's like the style guide for specs.
69
+
***Do** write [YARD] documentation - this makes it easier for people to use your code.
68
70
***Don't** fix a lot of things in one pull request. Small fixes are easier to validate.
69
71
70
72
#### Bug Fixes
71
73
72
74
***Do** include reproduction steps in the form of verification steps.
73
-
***Do** include a link to any corresponding [Issue](https://github.com/rapid7/metasploit-framework/issues) in the format of `See #1234` in your commit description.
75
+
***Do** include a link to any corresponding [Issues] in the format of
0 commit comments