Skip to content

Commit 6e9a136

Browse files
committed
Land rapid7#3191, CONTRIBUTING.md improvements
2 parents 6d72860 + 531686c commit 6e9a136

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ and Metasploit's [Common Coding Mistakes](https://github.com/rapid7/metasploit-f
2323

2424
### Pull Requests
2525

26+
* **Do** target your pull request to the **master branch**. Not staging, not develop, not release.
2627
* **Do** specify a descriptive title to make searching for your pull request easier.
2728
* **Do** include [console output](https://help.github.com/articles/github-flavored-markdown#fenced-code-blocks), especially for witnessable effects in `msfconsole`.
2829
* **Do** list [verification steps](https://help.github.com/articles/writing-on-github#task-lists) so your code is testable.
@@ -34,14 +35,15 @@ Pull requests [#2940](https://github.com/rapid7/metasploit-framework/pull/2940)
3435
#### New Modules
3536

3637
* **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.
3839
* **Don't** include more than one module per pull request.
3940

4041
#### Library Code
4142

4243
* **Do** write [RSpec](http://rspec.info/) tests - even the smallest change in library land can thoroughly screw things up.
4344
* **Do** follow [Better Specs](http://betterspecs.org/) - it's like the style guide for specs.
4445
* **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.
4547

4648
#### Bug Fixes
4749

0 commit comments

Comments
 (0)