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
I've seen a couple PRs targeting the wrong branch. Many projects have a
workflow where PRs should hit `develop` or `release` or something, but
Metasploit-Framework wants PRs targeted against `master`.
Also, warn against fixing too much in one PR since those kinds of PRs
are a) harder to validate and b) might be all wrong anyway. We don't
want people committing a bunch of work when the fundamental approach
isn't going to fly.
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+3-1Lines changed: 3 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,6 +23,7 @@ and Metasploit's [Common Coding Mistakes](https://github.com/rapid7/metasploit-f
23
23
24
24
### Pull Requests
25
25
26
+
**Do* target your pull request to the **master branch**. Not staging, not develop, not release.
26
27
***Do** specify a descriptive title to make searching for your pull request easier.
27
28
***Do** include [console output](https://help.github.com/articles/github-flavored-markdown#fenced-code-blocks), especially for witnessable effects in `msfconsole`.
28
29
***Do** list [verification steps](https://help.github.com/articles/writing-on-github#task-lists) so your code is testable.
***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).
37
-
***Do** use the [API](https://dev.metasploit.com/documents/api/). Wheel improvements are welcome; wheel reinventions, not so much.
38
+
***Do** use the [many module mixin APIs](https://dev.metasploit.com/documents/api/). Wheel improvements are welcome; wheel reinventions, not so much.
38
39
***Don't** include more than one module per pull request.
39
40
40
41
#### Library Code
41
42
42
43
***Do** write [RSpec](http://rspec.info/) tests - even the smallest change in library land can thoroughly screw things up.
43
44
***Do** follow [Better Specs](http://betterspecs.org/) - it's like the style guide for specs.
44
45
***Do** write [YARD](http://yardoc.org/) documentation - this makes it easier for people to use your code.
46
+
**Don't* fix a lot of things in one pull request. Small fixes are easier to validate.
0 commit comments