docs: 添加项目文档体系(架构/启动路线/路线图/贡献规范)
- docs/ARCHITECTURE.md: 架构设计文档,覆盖五大核心子系统 (SAS-R0-PCQ/UTSM/UTRW/DRR/DKM)、内存模型、驱动/文件/网络/图形子系统、 开放设计点 - docs/BOOT_SEQUENCE.md: 启动路线设计,原创 DBS 五阶段命名体系 (B0 Ignis/B1 Sigillum/B2 Transitus/B3 Origo/B4 Excitas), 启动契约/锚点/回退链机制 - docs/ROADMAP.md: 分阶段开发路线图,9 个 Phase + 5 个里程碑 - CONTRIBUTING.md: 贡献与协作规范,含代码规范/Git 工作流/PR 流程 - .github/: PR 模板 + Bug/Feature Issue 模板 - README.md: 更新为项目介绍 + 文档索引 + 构建说明 所有文档基于项目真实源码与设计文档编写,62 个交叉链接全部有效。
This commit is contained in:
@@ -0,0 +1,40 @@
|
||||
---
|
||||
name: Bug 报告
|
||||
about: 报告内核崩溃、驱动故障、构建失败等问题
|
||||
title: "[bug] "
|
||||
labels: bug
|
||||
---
|
||||
|
||||
## 问题描述
|
||||
|
||||
<!-- 简要描述问题 -->
|
||||
|
||||
## 复现步骤
|
||||
|
||||
1.
|
||||
2.
|
||||
3.
|
||||
|
||||
## 预期行为
|
||||
|
||||
<!-- 应该发生什么 -->
|
||||
|
||||
## 实际行为
|
||||
|
||||
<!-- 实际发生了什么 -->
|
||||
|
||||
## 环境
|
||||
|
||||
- 组件:<!-- UTSM / DSK / DKM:<驱动名> / FirstInit / 构建 -->
|
||||
- 运行环境:<!-- QEMU / 真机 -->
|
||||
- QEMU 参数(如非默认):
|
||||
|
||||
## 串口日志
|
||||
|
||||
```
|
||||
<!-- 粘贴 QEMU 串口输出,至少包含崩溃点前后上下文 -->
|
||||
```
|
||||
|
||||
## 崩溃分析(如适用)
|
||||
|
||||
<!-- 三重故障 / page fault / panic 时的寄存器、栈、调用上下文 -->
|
||||
@@ -0,0 +1,39 @@
|
||||
---
|
||||
name: 功能请求
|
||||
about: 提议新驱动、新子系统或架构改进
|
||||
title: "[feat] "
|
||||
labels: enhancement
|
||||
---
|
||||
|
||||
## 功能描述
|
||||
|
||||
<!-- 简要描述提议的功能 -->
|
||||
|
||||
## 动机
|
||||
|
||||
<!-- 为什么需要这个功能,解决什么问题 -->
|
||||
|
||||
## 涉及子系统
|
||||
|
||||
- [ ] UTSM 首阶段内核
|
||||
- [ ] DSK 主内核
|
||||
- [ ] DKM 驱动
|
||||
- [ ] 内存管理
|
||||
- [ ] 文件系统 / VFS
|
||||
- [ ] 网络
|
||||
- [ ] 调度器 (SAS-R0-PCQ)
|
||||
- [ ] 恢复系统 (DRR)
|
||||
- [ ] FirstInit / 用户空间
|
||||
- [ ] 文档
|
||||
|
||||
## 设计思路
|
||||
|
||||
<!-- 描述实现方案,如有 ABI / 架构影响请重点说明 -->
|
||||
|
||||
## 路线图对应
|
||||
|
||||
<!-- 对应 docs/ROADMAP.md 中的哪个 Phase?(如适用) -->
|
||||
|
||||
## 验收标准
|
||||
|
||||
<!-- 完成后如何验证 -->
|
||||
@@ -0,0 +1,52 @@
|
||||
## 变更说明
|
||||
|
||||
<!-- 简要描述本 PR 做了什么、为什么 -->
|
||||
|
||||
## 变更类型
|
||||
|
||||
- [ ] feat — 新功能
|
||||
- [ ] fix — 修复
|
||||
- [ ] docs — 文档
|
||||
- [ ] build — 构建系统
|
||||
- [ ] refactor — 重构
|
||||
- [ ] test — 测试
|
||||
- [ ] chore — 杂项
|
||||
|
||||
## 影响范围
|
||||
|
||||
<!-- 勾选受影响的子系统 -->
|
||||
- [ ] UTSM 首阶段内核
|
||||
- [ ] DSK 主内核
|
||||
- [ ] DKM 驱动(请列出具体驱动: )
|
||||
- [ ] DKM ABI / kernel_api
|
||||
- [ ] 文件系统 / VFS
|
||||
- [ ] 网络
|
||||
- [ ] FirstInit / 用户空间
|
||||
- [ ] 构建 / 镜像打包
|
||||
- [ ] 文档
|
||||
|
||||
## 提交前检查清单
|
||||
|
||||
- [ ] `.\build.bat` 构建成功,产出 `ISO/deshab.img`
|
||||
- [ ] `.\ISO\run_qemu.bat` 启动到 `[DSK] SELFTEST PASS`
|
||||
- [ ] 无新增编译 warning(`-Wall -Wextra`)
|
||||
- [ ] ABI 变更已同步所有驱动本地定义(未在结构体中间插入字段)
|
||||
- [ ] 新驱动已在 `manifest.json` + `limine.conf` 注册
|
||||
- [ ] 设计文档(`RE/`)与模块 README 已同步
|
||||
- [ ] 提交信息符合 Conventional Commits
|
||||
- [ ] `LESSONS_LEARNED.md` 已追加经验记录(如适用)
|
||||
|
||||
## 测试方式
|
||||
|
||||
<!-- 描述如何验证本变更,如 QEMU 参数、预期串口输出 -->
|
||||
|
||||
```text
|
||||
预期输出:
|
||||
```
|
||||
|
||||
## ABI / 兼容性影响
|
||||
|
||||
<!-- 如果修改了 dkm_kernel_api、driver_desc、dsk_boot_context 等 ABI,请说明:
|
||||
1. 新增字段是否追加到结构尾部
|
||||
2. 是否影响已有驱动
|
||||
3. min_kernel_abi / abi_version 是否需要变更 -->
|
||||
Reference in New Issue
Block a user