infosecn1nja
/
metasploit-framework
mirror of https://github.com/infosecn1nja/metasploit-framework.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Adding minor edits to HACKING: License language, updating contact info, svn keywords, and Author attribution. 

git-svn-id: file:///home/svn/framework3/trunk@13890 4d416f70-5f16-0410-b530-b9f4589650da
unstable
Tod Beardsley 2011-10-12 16:01:06 +00:00
parent 90a426cec6
commit 9bbb104115
1 changed files with 12 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
HACKING
View File

@ -18,7 +18,7 @@ adhere to the following style guidelines:
- Method names should always be lower_case and words separated by "_" - Method names should always be lower_case and words separated by "_"
- Variable names should be lower case with words separated by "_" - Variable names should be lower case with words separated by "_"
- Don't depend on any external gems or libraries without talking to - Don't depend on any external gems or libraries without talking to
egypt to resolve packaging and licensing issues todb to resolve packaging and licensing issues
You can use the the "./tools/msftidy.rb" script to do some rudimentary You can use the the "./tools/msftidy.rb" script to do some rudimentary
checking for various violations. checking for various violations.
@ -128,14 +128,21 @@ email it framework@metasploit.com, which is the main mailing list
for framework users, or msfdev@metasploit.com which only goes to for framework users, or msfdev@metasploit.com which only goes to
developers. developers.
The SVN keywords for Id and Revision should remain blank, as the SVN
checkin will handle those substitutions automatically. The Author
field is not automatic, and should be filled in in the format of
'Yourname <user[at]domain.tld>' so future developers can contact
you with any questions.
Licensing Licensing
========= =========
By submitting code contributions to the Metasploit Project it is By submitting code contributions to the Metasploit Project it is
assumed that you are offering your code under a BSD or similar assumed that you are offering your code under the Metasploit License
license. MIT and Ruby Licenses are also fine. We specifically cannot or similar 3-clause BSD-compatible license. MIT and Ruby Licenses
include GPL code. LGPL code is accepted on a case by case basis for are also fine. We specifically cannot include GPL code. LGPL code
libraries only and is never accepted for modules. is accepted on a case by case basis for libraries only and is never
accepted for modules.
When possible, such as aux and exploit modules, be sure to include When possible, such as aux and exploit modules, be sure to include
your license designation in the file in the appropriate place. your license designation in the file in the appropriate place.