Skip to content

Latest commit

 

History

History
62 lines (40 loc) · 3.33 KB

CONTRIBUTING.md

File metadata and controls

62 lines (40 loc) · 3.33 KB

贡献指南

本轮内容定位与写作入口

知识库同时维护基础知识全量参考、从 0 到 1 的路径、高级扩展和有长期价值的框架学习。首先遵循写作与验收规范:关键词、内置函数与常用标准库需要解释输入输出、例子与边界;教程应就地讲清当前步骤,不只链接字典。

优先补知识和反馈缺口,不以统一标题、堆砌术语或增加篇数代替增强。参考词条的覆盖率与示例正确性分别核查;未运行的平台不要写“实测通过”。

感谢你对 Dev Quest 的关注!本项目是个人学习路径仓库,欢迎通过 Issue 反馈问题或提交内容改进。

贡献流程

  1. 反馈问题: 发现文档错误、失效链接或内容过时,请提交 Issue 并注明具体文件与位置
  2. 内容贡献: Fork 仓库 → 创建分支 → 修改内容 → 提交 Pull Request
  3. PR 要求: 描述改动范围与动机,确保不引入新的失效引用

提交信息规范

使用以下前缀(与现有提交历史保持一致):

前缀 用途 示例
feat: 新增内容/功能 feat: 完成02-nextjs-frontend模块现代化重构
refactor: 结构调整/重构 refactor: 模块编号 04-12 重排为 03-11
fix: 修复错误 fix: 修复重构归档中的相对路径引用
docs: 文档修正 docs: 修复全部陈旧引用并对齐新模块布局
chore: 杂项维护 chore: 清理冗余文件

写作规范

新增或修改文档前,请阅读以下规范文件:

必做检查

  • 新文档使用标准模板骨架
  • 交叉引用使用相对路径且目标文件存在
  • 已同步更新 文档索引
  • 已同步更新 学习进度
  • 版本号/安装命令/API 签名等易变内容已核对模块 README 的"技术基线"区块

技术基线年度复核

知识库通过"基线集中声明"控制过时成本(详见文档规范指南的技术基线声明章节)。维护惯例:

  1. 每年至少一次(建议 9 月)核实各模块 README 基线区块的版本号,来源为官方发布页
  2. 核实后运行 grep -rEn "<旧大版本模式>" --include="*.md" 0*/ 10-*/ 定位残留的易变层引用并批量更新
  3. 大版本更迭(如 Next.js 15→16)需同步修订正文中的 breaking changes 相关示例
  4. 运行相关检查,并在提交说明中概述本次基线核实结论

模块结构

每个技术模块遵循统一结构(README + basics/advanced-topics/reference/frameworks/projects/testing/deployment),详见模块结构指南。

许可证

提交内容即表示你同意该贡献按 MIT License 授权。