【译】Metasploit:社区贡献指南



你好,世界!

非常感谢您对开发 Metasploit 感兴趣,因此,世界 -- 一个更美好的地方!

请问您是想要来报告 BUG 吗?这里是我们的 Issue tracker
请尽可能详细地描述您的问题; 包括重现步骤(如果有帮助,从控制台输出中剪切并粘贴)以及您期望发生的事情。

请问您是想要报告一个 Metasploit 自己本身的漏洞吗?多么讽刺! 请查看 Rapid7 的漏洞披露政策,并使用我们的PGP密钥将您的报告发送至 security@rapid7.com

请问您是想要提供一些新功能,错误修复或新的 Metasploit 模块吗? 如果是这样,那么就请继续阅读吧!

为 Metasploit 贡献

您在 CONTRIBUTING.md 中看到的内容是关于如何确保您的宝贵贡献真正融入 Metasploit 主分支以及一些不该做的事情的一个列表。
如果你不关注这些规则,你的贡献被关闭。 抱歉!
本文将会是一个简短的列表。 本项目的 wiki 将会更详尽,揭示了许多谜团。 如果您没有阅读其他内容,请参阅标准 开发环境设置指南Metasploit 的常见编码错误

代码方面的贡献

  • 坚持遵守 Ruby 风格指南
  • 根据您添加或修改的代码,使 Rubocop 相对安静。(译者注:Rubocop 是 Ruby 的一个代码检查器)
  • 对于Git提交消息,遵循 50/72 规则
  • 请不要 在分支合并的时候使用默认消息,尽可能留下描述信息。
  • 将你的代码在 BSD 3-clause, BSD 2-clause, 或者 MIT 开源许可证下发布
  • 创建一个主题分支(译者注:topic branch)来处理,而不是直接在 master 分支上工作。 如果您没有从 主题分支 发送 PR(译者注:Pull Request),只要您更新自己的 master 分支,您的 PR 历史将会丢失。 请参阅 https://github.com/rapid7/metasploit-framework/pull/8000 以了解其中的一个示例。

Pull Requests

  • 将您的 Pull Request 定位到主分支,而不是 staging,develop 或者 release 分支。
  • 指定一个描述性的标题来能使你的 Pull Request 被更容易地搜索到。
  • 包含 控制台输出 ,特别是对于在 msfconsole 中可见的效果。
  • 列出 verification steps 验证步骤以便保证你的代码是可被评测的。
  • 在您的 Pull Request 说明中引用相关 issue (译者注:如果你的 Pull Request 是为了专门解决某一个 Issue 中提出的问题或者修复某一个 Issue 中提出的 Bug的时候可以参考本条建议)。
  • 在你的 Pull Request 被落实(译者注:landed,个人理解为合并了你的 Pull Request)后撰写 release notes
  • 请不要 让你的 Pull Request 的描述为空
  • 请不要 放弃你的 Pull Request, 快速的响应可以帮助我们更快地落实(译者注:land,个人理解为合并你的 Pull Request)你的代码。

Pull requests PR#2940PR#3043 是一组很好的可以被追随的例子。

新的模块

脚本

  • Don't submit new scripts. Scripts are shipped as examples for automating local tasks, and anything "serious" can be done with post modules and local exploits.
  • 请不要 提交新的脚本 scripts, 脚本会作为自动化本地任务的示例发布,任何 “严重” 的事情都可以通过后期模块(译者注:post modules)和本地漏洞利用(译者注:local exploit)来完成。

库代码(译者注:Library Code)

  • 编写 RSpec 测试用例,因为即使是 library 层的最小变化也可能导致崩溃。
  • 按照 更好的规格说明 ,就像规格指南的风格一样。
  • 编写 YARD 文档,这会让人们更加容易地使用你的代码。
  • 请不要 在一个 Pull Request 中修复多个问题,较小的修复会更加容易被验证。

Bug 修复

  • 在验证步骤(译者注:verification steps)中包含重现步骤。
  • 在提交描述中包含指向任何相关 Issues 的链接,格式为请参阅 See #1234

Bug 报告

  • 将漏洞报告直接发送给 Rapid7 Software security@rapid7.com.
  • 为您的报告撰写一个描述性的标题和较为详细的描述信息
  • 包含重现的步骤、函数调用栈以及其他任何可能对我们修复您的 Bug 有帮助的信息。
  • 请不要 重复提交相同的报告,请在您提交一个新的报告之前先进行搜索确保没有重复。

如果你还需要更多的指南或者有别的疑问,那么你可以在 Freenode IRC channel 和主要的开源开发者进行交流 或者 给我们的邮件列表 metasploit-hackers 发送邮件来咨询。

最后,感谢 您花费一小段时间来阅读这篇说明!你已经领先于曲线,所以继续保持!

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 157,612评论 4 361
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 66,814评论 1 290
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 107,427评论 0 239
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,743评论 0 203
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,104评论 3 286
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,455评论 1 214
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,764评论 2 311
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,454评论 0 196
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,159评论 1 239
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,446评论 2 244
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,953评论 1 258
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,294评论 2 252
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,927评论 3 235
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,028评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,784评论 0 193
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,485评论 2 270
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,395评论 2 264

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,095评论 18 139
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 170,549评论 25 707
  • 原文地址:https://github.com/rapid7/metasploit-framework/wiki/...
    王一航阅读 903评论 0 1
  • 外婆九十一岁了,满口的牙齿被岁月侵蚀,只剩下为数不多的几颗还在坚守岗位。满脸的皱纹刻画着岁月的风霜。外婆没有文化,...
    于小五阅读 265评论 0 3
  • 成功起航
    爱心园阅读 145评论 0 0