贡献指南#

欢迎参与 OS Debug 的开发。本指南说明如何认领任务、提交代码，以及一些团队约定。

1. 如何参与#

• 先阅读项目全景与路线图，了解各子项目当前状态与未来规划
• 按照开发环境搭建把插件跑起来
• 在路线图的「未来规划」中挑选感兴趣的任务

2. 提 Issue#

提交 issue 时请尽量包含：

• 问题现象与复现步骤
• 环境信息：操作系统、QEMU/GDB 版本、插件版本（commit）
• 相关日志：调试控制台输出、code_debug_qemu_output_history.txt 等

3. 提 Pull Request#

• 一个 PR 只做一件事，标题描述清晰
• 修改后先本地验证：npm run compile 通过、在调试目标上验证功能正常
• PR 描述中说明改了什么、为什么改、如何验证

4. 文档同步要求#

改了功能，必须同步改文档。 具体包括：

• 插件行为、launch.json 配置项变化 → 更新对应的使用教程与功能介绍
• 新增支持的调试目标 → 更新支持矩阵与对应教程
• 阶段成果 → 更新路线图与首页「最新动态」

这条约定是为了避免文档落后于代码，希望后续不再发生。