Skip to content

contributing.md

Latest commit

 

History

History
97 lines (67 loc) · 2.62 KB

contributing.md

File metadata and controls

97 lines (67 loc) · 2.62 KB
Raw

🛠️ 如何参与贡献 Vulnerability-Wiki？

非常欢迎你参与到 Vulnerability-Wiki 的建设中来！ 我们希望这是一个由安全研究者、安全学习者和技术爱好者共同维护的开放知识平台。

以下是参与贡献的基本流程和注意事项👇

作者信息填写规范（推荐）

为了增强归属感和署名权，建议在每篇文档的最底部添加如下引用块：

> 📝 **作者**：Zhang San  
> 📧 **邮箱**：zhangsan@tsinghua.edu.cn  
> 🏫 **单位**：Tsinghua University  
> 📅 **最后更新时间**：2025-xx-xx

📌 贡献类型

你可以从以下方面参与贡献：

  • ✍️ 编写或完善某类漏洞的内容文档（Web、系统、IoT 等）
  • 🧠 增补 CVE、CWE、OWASP 等分类下的案例
  • 🧹 修复错别字、格式问题、链接失效等
  • 🌐 翻译内容或撰写多语言版本
  • 🚧 参与重大结构设计（如目录组织、模板优化等）

🚀 快速开始

  1. Fork 本项目
    点击右上角的 Fork 按钮，创建属于你的副本仓库。

  2. Clone 到本地并安装依赖

   git clone https://github.com/你的用户名/Vulnerability-wiki.git
   cd Vulnerability-wiki
   pip install -r requirements.txt
  1. 本地运行 MkDocs 服务
   mkdocs serve
   # 然后访问 http://127.0.0.1:8000 查看你的修改效果（支持热重载）。

  1. 编辑或新增文档内容
    请在 docs/ 目录下修改对应 .md 文件，注意结构清晰、命名规范。

  2. 提交并发起 Pull Request（PR）

   git checkout -b my-contribution
   git add .
   git commit -m "feat: 添加 Web XSS 漏洞文档"
   git push origin my-contribution

   然后在 GitHub 页面点击“Compare & Pull Request”，提交合并请求。

🧾 编辑规范

  • 所有文档必须使用 Markdown（.md）格式。
  • 尽量保持语言简洁、专业、准确。
  • 每类漏洞建议包括：
    • 漏洞介绍
    • 原理分析
    • 利用方式
    • 防御思路
    • 真实案例（如 CVE 编号、漏洞平台）
  • 所有引用内容请注明出处，尊重知识产权。

⚖️ 法律与道德声明

我们坚决反对将本项目中提及的技术用于非法目的。
请勿在未授权的系统中测试漏洞，也不要传播利用代码。

本 Wiki 仅供学习、研究、教学与防御目的使用。

❤️ 感谢

感谢每一位为知识自由共享贡献力量的你！

你可以在贡献者页面看到自己的头像👇
https://github.com/ahlien/Vulnerability-wiki/graphs/contributors

一起让漏洞知识更系统、更易懂、更有力量 💪