From 27aa5dd6149d970f7fe548ec822cf4399ce84ab5 Mon Sep 17 00:00:00 2001
From: Medicean <Medici.Yan@Gmail.com>
Date: Sun, 13 Nov 2016 15:05:07 +0800
Subject: [PATCH] =?UTF-8?q?=E6=B7=BB=E5=8A=A0=E8=AF=B4=E6=98=8E=E6=96=87?=
 =?UTF-8?q?=E6=A1=A3?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

* 致谢列表
* PR模版
* 贡献说明
---
 .github/CONTRIBUTING.md          | 148 +++++++++++++++++++++++++++++++
 .github/PULL_REQUEST_TEMPLATE.md |  27 ++++++
 README.md                        |   7 ++
 THANKS.md                        |   5 ++
 4 files changed, 187 insertions(+)
 create mode 100644 .github/CONTRIBUTING.md
 create mode 100644 .github/PULL_REQUEST_TEMPLATE.md
 create mode 100644 THANKS.md

diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
new file mode 100644
index 0000000..636f9d3
--- /dev/null
+++ b/.github/CONTRIBUTING.md
@@ -0,0 +1,148 @@
+CONTRIBUTING to VulApps
+---
+
+> 很多公司都在做类似的事情，真正开放的并没有几个。我希望的是大家来共同维护着一个开源的靶场。在你从本项目中获取某个有用的环境时，相对的，我希望你能向 VulApps 贡献一个环境。
+
+## 向 VulApps 贡献前需要注意的几个点：
+
+- [接受何种形式的贡献](#cc)
+- [目录结构](#dir)
+- [漏洞环境文件说明](#files)
+- [Commit 规范](#commit)
+- [贡献流程](#howto)
+- [相关链接](#url)
+
+### <a name="cc"></a>接受何种形式的贡献
+
+* 新增环境及完善资料
+    * Dockerfile
+    * 漏洞详细说明
+    * 漏洞 poc
+    * 漏洞 exp
+* 原有环境 Bug 修复
+
+### <a name="dir"></a>VulApps 目录结构
+
+`/组件首字母/组件名/该组件的目录下的维一编号/`
+
+> 一律采取小写
+> 
+> 唯一编号推荐使用 uuid4 `$ python -c "print __import__('uuid').uuid4()"`
+
+```
+.
+├── README.md
+├── base 组件基础镜像
+├── 组件首字母
+│   ├── README.md(组件列表)
+│   └── 组件名
+│       ├── README.md(组件漏洞靶场列表)
+│       ├── 唯一编号
+│       └── 唯一编号
+├── b
+│   ├── README.md
+│   └── bash
+│       ├── README.md
+│       ├── 7d116603-c066-4821-8a5f-5dc0d39d71c7
+│       └── 1d7b5557-e074-4114-ace5-50c110032cb5
+└── s
+    ├── README.md
+    └── struts2
+        ├── README.md
+        └── 3f9af03f-3800-4f4e-807f-19c05f94e9d1
+```
+
+### <a name="files"></a>漏洞环境文件说明
+
+```
+.
+├── README.md    靶场说明(需要指明环境中的相关信息)
+├── poc.py       检测插件
+├── exp.py       漏洞利用程序
+├── Dockerfile
+└── src          构建所需要的配置文件(超过 10MB 的请使用外链，推荐7牛)
+    ├── ...
+    └── ...
+```
+
+### <a name="commit"></a>Commit 规范
+
+Commit 分为标题和主体两部分，标题要求必须要简洁明了。对标题的详细补充在主体中体现，如果标题已经充分表达出提交者的意思，主体可省略。
+
+```
+(操作 镜像类型: 影响的组件名) 插件名或组件版本号
+<空行>
+详细的说明
+```
+
+* 操作:
+ * Add    添加
+ * Update 更新
+ * Fix    修补 Bug
+ * Delete 删除
+
+* 镜像类型
+ * Base   基础镜像
+ * Vul    漏洞环境
+ * Tools  安全工具
+
+**下面给出了一些例子：**
+
+* 新增 WordPress 某个插件的漏洞环境
+
+```
+(Add Vul: WordPress) double-opt-in-for-download
+
+添加 double-opt-in-for-download.2.0.9 SQL 注入漏洞环境
+
+该漏洞需要登录触发
+```
+
+* 新增了 WordPress 某个基础镜像
+
+```
+(Add Base: WordPress) 4.5.3
+
+添加 WordPress 4.5.3 基础镜像
+```
+
+* 更新了 Discuz! 基础镜像的某个版本
+
+```
+(Update Base: Discuz) 7.2
+
+* 更新了删除源码包的操作
+* 在安装完毕后，自动卸载 `curl` 与 `wget`
+```
+
+* 修正了 PHPCms 基础镜像中的某个 Bug
+
+```
+(Fix Base: PHPCms) #2
+
+修复了 #2 中提到的访问路径错误的 Bug
+```
+
+* 删除了某个漏洞镜像
+
+```
+(Delete Vul: Wordpress) double-opt-in-for-download 2.0.8
+
+该漏洞环境与现有的 2.0.9 版本环境重复
+```
+
+### <a name="howto"></a>贡献流程
+
+* Step1. fork 本仓库到你自己的仓库
+
+* Step2. clone 自己的仓库到本地
+
+* Step3. 本地添加环境或修改文档，然后推至远端自己的仓库
+
+* Step4. 发起 Pull Request
+
+### <a name="urls"></a>相关链接
+
+* [Docker 从入门到实践](http://udn.yyuap.com/doc/docker_practice/)
+* [Docker 官网](https://www.docker.com/)
+* [Docker 官方文档](https://docs.docker.com/)
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 0000000..4eb79c4
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,27 @@
+<!--
+首先非常感谢您能参与到 VulApps 这个开源项目当中来。
+
+在提 PR 之前，需要你先确认一下下列基础信息
+
+如果你选中了某一项，可以把该行前面的 `[ ]` 改成 `[x]`。
+-->
+
+- [ ] 每个 Commit 都符合 CONTRIBUTING 中提到的规范(https://github.com/Medicean/VulApps/blob/master/.github/CONTRIBUTING.md#commit)
+- [ ] PR 中提到的所有环境都在测试构建成功
+- [ ] 每个目录中的 README 的索引我也同步更新了
+
+---
+
+** 本 PR 都主要是属于哪一类的呢？**
+
+```
+[ ] 修复已有环境 Bug
+[ ] 新增环境
+[ ] 文档和漏洞描述完善
+[ ] 其它：(请在此描述...)
+```
+
+---
+
+**详细描述**
+
diff --git a/README.md b/README.md
index 9aeb987..70e33a3 100644
--- a/README.md
+++ b/README.md
@@ -100,3 +100,10 @@ docker run -d -p 80:8080 medicean/vulapps:s_struts2_s2-037
 ### [Z](./z/)<div id="z"></div>
 
 * [Zabbix](./z/zabbix/)
+
+---
+
+## 相关链接
+
+* [如何参与VulApps](./.github/CONTRIBUTING.md)
+* [致谢列表](./THANKS.md)
diff --git a/THANKS.md b/THANKS.md
new file mode 100644
index 0000000..67469ed
--- /dev/null
+++ b/THANKS.md
@@ -0,0 +1,5 @@
+致谢列表
+---
+
+* ![@light4](https://avatars1.githubusercontent.com/u/1318472?v=3&s=50)@light4
+* ![@justkg](https://avatars1.githubusercontent.com/u/10934208?v=3&s=50)@justkg