MonkeyType项目贡献指南与技术规范解析

MonkeyType项目贡献指南与技术规范解析

monkeytype The most customizable typing website with a minimalistic design and a ton of features. Test yourself in various modes, track your progress and improve your speed. 项目地址: https://gitcode.com/gh_mirrors/mon/monkeytype

项目技术栈概述

MonkeyType作为一款开源的打字测试应用，采用了现代化的Web技术栈构建。其核心技术架构包含：

1. 前端技术：

   • 主要采用TypeScript（已从JavaScript迁移）
   • 配合标准的CSS和HTML实现界面展示
   • 按代码量排序：TypeScript > CSS > HTML

2. 后端架构：

   • Node.js作为运行时环境
   • MongoDB负责用户数据持久化存储
   • Firebase处理用户认证流程
   • Redis用于临时数据存储（包括每日排行榜、后台任务队列等）

3. 开发工具链：

   • 使用Prettier进行代码格式化
   • 采用Conventional Commits规范提交信息

贡献类型与流程

基础贡献

对于不涉及核心代码修改的贡献，主要包括：

1. 语言包扩展：

   • 支持新增打字测试的语言词库
   • 需要遵循严格的JSON格式规范

2. 名言引用添加：

   • 扩充打字测试的引用文本库
   • 包含多语言支持要求

3. 主题样式设计：

   • 新增视觉主题方案
   • 需要兼顾可读性和美观性

这类贡献无需搭建本地开发环境，通过简单的文件编辑即可完成。

高级代码贡献

涉及功能修改或新增的代码级贡献需要：

1. 完整的本地开发环境搭建
2. 代码变更的详细说明
3. 必要的界面截图展示
4. 遵循项目代码规范和提交准则

技术规范详解

代码提交规范

项目采用Conventional Commits规范，主要提交类型包括：

| 类型 | 用途描述 | |------------|--------------------------------------------------------------------------| | feat | 新增功能 | | impr | 现有功能改进 | | fix | 缺陷修复 | | docs | 文档更新 | | refactor | 不影响功能的代码重构 | | perf | 性能优化 | | test | 测试相关变更 |

主题设计规范

1. 独特性要求：

   • 必须与现有主题有明显视觉差异
   • 避免颜色和风格的过度相似

2. 可读性标准：

   • 主文本颜色需接近纯黑(#000000)或纯白(#FFFFFF)
   • 需在各种显示模式下测试可读性（包括反色模式和彩色模式）

3. 实现要求：

   • 必须正确配置textColor属性
   • 需在_list文件中注册新主题

语言包规范

1. 内容要求：

   • 禁止包含不当词汇
   • 保持词库的实用性和多样性

2. 格式规范：

   • 严格遵循JSON标准格式
   • 禁止使用尾部逗号
   • 文件命名需反映词库容量（如1k表示1000词）

3. 注册要求：

   • 需在_list和_groups文件中声明新语言

引用文本规范

1. 内容准则：

   • 禁止不当内容
   • 最小长度限制为60字符
   • 避免重复引用

2. 格式要求：

   • 正确设置length属性（字符数）
   • id需顺序递增
   • 非英语引用需提供翻译说明

3. 多语言支持：

   • 非英语内容需在提交时附带翻译
   • 便于审核内容适当性

最佳实践建议

1. 开发准备：

   • 熟悉TypeScript特性（特别是类型系统）
   • 了解Node.js异步编程模型

2. 代码质量：

   • 保持代码风格与项目一致
   • 复杂变更建议先讨论实现方案

3. 测试建议：

   • 主题设计需在各种显示模式下验证
   • 语言包应测试特殊字符显示

4. 提交说明：

   • 清晰描述变更目的
   • 关联相关issue（如存在）

通过遵循这些技术规范和最佳实践，开发者可以更高效地为MonkeyType项目做出有价值的贡献，同时确保项目代码库的质量和一致性。

monkeytype The most customizable typing website with a minimalistic design and a ton of features. Test yourself in various modes, track your progress and improve your speed. 项目地址: https://gitcode.com/gh_mirrors/mon/monkeytype