Cygnus-Security/soar-mcp-platform

# 🔐 CyberSec 实习 - 每周汇报 本仓库用于管理、追踪和审查所有实习成员的每周进度报告。 ## 🎯 目标 - 确保一致的**每周汇报** - 通过 **GitHub** 追踪个人进度 - 构建可组合为最终报告的结构化内容 ## 📌 通用规则 - 每位成员必须**每周恰好提交一份报告** - 所有提交必须推送到 **GitHub** - 严格遵守**命名规范** - 每份报告应采用**清晰且可复用的格式**撰写 ## 🌿 分支管理 每位成员必须在**自己的分支**上工作 ### 📛 命名规范 ``` ``` ### ✅ 示例 ``` tran-van-a nguyen-duc-minh ``` ### ❗ 规则 - 使用小写字母 - 用 `-` 替换空格 - 不要使用越南语变音符号 - 不要直接向 `main` 分支提交 ## 📅 每周文件夹结构 ### 📛 格式 ``` week_ ``` ### ✅ 示例 ``` week1_27-03-2026 ``` ## 📄 报告命名规范 ### 📛 格式 ``` week__.pdf ``` ### ✅ 示例 ``` week1_api-testing_crapi.pdf week2_ids_wazuh.pdf week3_rag_qwen.pdf ``` ## 📂 必备内容 每个每周文件夹必须包含： - `report.pdf`（主报告 - 必需） - `report_.pdf`（可选的易读版本） - `source_code/`（代码、配置、脚本） - `notes.md`（可选） ## 🧠 结构化报告（重要） 每份每周报告的撰写方式应满足： - 可作为独立的每周进度报告 - 日后可**合并为最终报告/文档** 👉 这意味着： - 书写清晰且正式 - 避免个人/日记式的写法 - 专注于可复用的技术内容 ## 📘 每周报告模板（必须遵循） ### 1. 贡献范围 - 本周对项目的哪部分做出了贡献 ### 2. 本周目标 - ... ### 3. 详细工作 #### 3.1 描述 #### 3.2 设计 / 方法 #### 3.3 实现 ### 4. 成果 / 产出 ### 5. 分析 ### 6. 问题与修复 ### 7. 可复用内容 ⭐（必需） - 以清晰、正式的风格撰写 1-2 页 - 本部分应能在最终文档中复用 ### 8. 下一步计划 ## 🐙 GitHub Issue 工作流（必需） 为确保清晰的沟通与追踪，所有任务必须通过 **GitHub Issues** 进行管理。 ### 📌 1. 每个任务 = 一个 Issue 每个任务都必须作为一个独立的 issue 创建。 #### 命名格式： ``` [Week X] - ``` ### 📄 2. Issue 模板 每个 issue 必须遵循以下结构： ``` ## 📌 Description What is this task about? ## 🎯 Objective - ## 📂 Expected Output - ## 🛠 Tools / Tech - ## ⏱ Deadline - ## 🔗 Related - Report folder: - PR: ## 📝 Notes - ``` ### 📊 3. 工作日志（必需） 所有学生必须使用评论在 issue 中直接更新进度。 #### 🔥 格式（强制要求）： ``` ### 📅 Day X (dd-mm) Time spent: Xh Work done: - Result: - Issue: - Next: - ``` #### ❗ 规则： - 必须每 1-2 天更新一次 - 必须创建新评论（不要编辑旧评论） - 必须包含所有字段 #### ❌ 无效示例： ``` Did research ``` ### 👤 4. 分配与标签 - 将 issue 分配给负责人 - 使用标签，例如： - `week1`, `week2` - `api`, `ids`, `nginx` - `review`, `urgent` ### 🔄 5. 工作流 #### 实习生： - 定期更新工作日志 - 在 Project Board 上移动卡片 - 完成后： ``` - Done - PR: # - Report: ``` - 关闭 issue ### 🔗 6. 关联（重要） #### 在 commit 中： ``` git commit -m "week X: (#issue_number)" ``` #### 在 PR 中： ``` Closes #issue_number ``` ## 🔄 工作流 (Git) ``` git checkout main git pull origin main git checkout git add . git commit -m "week X: report" git push origin ``` ## 🚀 提交流程 - 创建指向 main 的 Pull Request - 标题： ``` [Week X] Full Name - Topic ``` ## ⚠️ 重要注意事项 - ❌ 禁止直接向 main 提交 - ❌ 缺失报告 → 拒绝 - ❌ 格式错误 → 拒绝 - ❌ 无 issue 追踪 → 拒绝 - ❌ 无工作日志 → 拒绝 - ✅ 必须包含“可复用内容” - ✅ 必须关联 issue ↔ PR ↔ 报告 ## ✅ 检查清单 - [ ] 正确的分支 - [ ] 正确的文件夹名称 - [ ] 报告文件命名正确 - [ ] 包含可复用内容部分 - [ ] 已创建并更新 issue - [ ] 已更新工作日志 - [ ] PR 已关联至 issue - [ ] 已推送并创建 PR ## 🏁 结语 每周报告是基础的构建模块。 如果撰写得当： 👉 它们日后可以组合成一份完整的最终文档 祝研究愉快 🚀

标签：Linux 内核安全, 协同办公, 实习培训, 文档管理, 网络安全研究, 进度追踪, 防御加固, 项目管理