Skip to content

Commit 1cef61b

Browse files
committed
Link README to CONTRIBUTING
1 parent b973927 commit 1cef61b

File tree

2 files changed

+36
-2
lines changed

2 files changed

+36
-2
lines changed

CONTRIBUTING.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Contributing to Metasploit
2+
3+
## Reporting Bugs
4+
5+
If you would like to report a bug, please take a look at [our Redmine
6+
issue
7+
tracker](https://dev.metasploit.com/redmine/projects/framework/issues?query_id=420)
8+
-- your bug may already have been reported there!
9+
10+
If your bug is new and you'd like to report it you will need to
11+
[register
12+
first](https://dev.metasploit.com/redmine/account/register). Don't
13+
worry, it's easy and fun and takes about 30 seconds.
14+
15+
## Contributing Exploits
16+
17+
If you have an exploit that you'd like to contribute to the Metasploit
18+
Framework, please familiarize yourself with the
19+
[HACKING](https://github.com/rapid7/metasploit-framework/blob/master/HACKING)
20+
document in the
21+
Metasploit-Framework repository. There are many mysteries revealed in
22+
HACKING concerning code style and content.
23+
24+
[Pull requests](https://github.com/rapid7/metasploit-framework/pulls)
25+
should corellate with modules at a 1:1 ratio
26+
-- there is rarely a good reason to have two, three, or ten modules on
27+
one pull request, as this dramatically increases the review time
28+
required to land (commit) any of those modules.
29+
30+
Pull requests tend to be very collaborative for Metasploit -- do not be
31+
surprised if your pull request to rapid7/metasploit-framework triggers a
32+
pull request back to your own fork. In this way, we can isolate working
33+
changes before landing your PR to the Metasploit master branch.

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,11 @@ reading some of the great tutorials online:
4040

4141
Contributing
4242
--
43-
See the [Dev Environment Setup][wiki-devenv] guide on github which will
43+
See the [Dev Environment Setup][wiki-devenv] guide on GitHub which will
4444
walk you through the whole process starting from installing all the
4545
dependencies, to cloning the repository, and finally to submitting a
46-
pull request.
46+
pull request. For slightly more info, see
47+
[Contributing](https://github.com/rapid7/metasploit-framework/blob/master/CONTRIBUTING.md).
4748

4849

4950
[wiki-devenv]: https://github.com/rapid7/metasploit-framework/wiki/Metasploit-Development-Environment "Metasploit Development Environment Setup"

0 commit comments

Comments
 (0)