贡献指南 (Contributor Guide)
欢迎参与《前端面试》知识库的开源贡献！本项目致力于打造工业级、前沿且具备可交互模拟的高质量面试题库与前端架构知识体系。
贡献模块导航
| 模块 | 说明 | 核心价值 |
|---|---|---|
| 01. 项目架构 | 核心技术栈、工程分层、插件系统与元数据提取机制 | 了解项目底层架构与扩展机制 |
| 02. 工作流规范 | 科目/主题创建规范、题目收录标准、Git 分支与 PR 提交流程 | 掌握题目收录标尺与规范流程 |
| 03. 交互组件与沙盒实战 | CustomSandPack 代码沙盒与 React 可视化模拟器开发规范 | 开发交互式架构模拟与运行沙盒 |
| 规范模板库 | 包含问题模板、主题模板与公司模板 | 开箱即用的标准化题目与解析模版 |
待办事项与产品里程碑
- 核心结构与基础功能 (MVP 第一阶段)
- 规则制定
- 题目收录标准
- 答案模版标准
- 目录结构与文件命名
- 统一目录命名格式：
<序号>-<科目名>- 重命名科目目录（如
01-javascript替代01.01.js） - 调整子科目命名方式（如
01-01-javascript）
- 重命名科目目录（如
- 重命名兜底文件
-
coding.md→programming.md -
other.md→miscellaneous.md
-
- 统一目录命名格式：
- 内容组织优化
- 明确科目划分规则
- 定义核心科目（JavaScript、HTML、CSS、网络基础）
- 规范扩展科目组织（如 TypeScript 作为 JavaScript 子科目）
- 重构答案目录结构
- 按主题分类而非问题 ID
- 创建标准化 README 模板
- 明确科目划分规则
- 用户体验与文档 (MVP 第二阶段)
- 补充功能
- 支持按照题目优先级，或者特定搜索条件刷题
- 文档完善
- 增强模板文件
- 添加内嵌注释与填写指南
- 提供完整示例
- 创建入门教程
- 编写快速入门指南
- 录制操作演示视频
- 增强模板文件
- 用户体验增强
- 实现标签系统
- 定义标准标签集（如
#高频考点、#大厂真题） - 集成 Docusaurus 标签插件
- 定义标准标签集（如
- 添加交互式索引表格
- 支持按难度、考察频率排序
- 实现标签系统
- 工具与自动化 (MVP 第三阶段)
- 工具与自动化
- 配置 GitHub Actions CI/CD 流程
- 目录命名规范检查
- 自动运行测试用例
- 部署前检查死链
- 开发目录结构校验脚本
- 检查序号连续性
- 验证命名一致性
- 配置 GitHub Actions CI/CD 流程
- 扩展功能 (未来迭代)
- 扩展性与维护
- 开发贡献模板自动化工具
- 创建科目生成命令
- 创建主题生成命令
- 规范化题目元数据
- 定义 Front Matter 格式（公司、年份、难度）
- 更新现有题目添加元数据
- 开发贡献模板自动化工具
- 补充高级功能
- 支持随机组卷评测功能
- 支持随机面试组卷评测，ai 辅导功能
- 支持用户能力评估功能，评估当前 subject 下，topic 的掌握情况
- 用户体验进阶
- 集成代码运行环境
- 添加 CodeSandbox 嵌入功能
- 提供本地运行脚本
- 集成代码运行环境