NativeMindBrowser/NativeMindExtension 项目开发指南

项目概述

NativeMindBrowser/NativeMindExtension 是一个浏览器扩展项目，旨在提供高效的网页浏览体验和增强功能。该项目采用现代前端技术栈，包括 Vue.js 框架和 TypeScript 语言，遵循组件化开发模式。

开发规范与最佳实践

代码提交规范

良好的提交信息是项目可维护性的重要保障。本项目采用以下提交规范：

1. 使用现在时态（如"修复问题"而非"修复了问题"）
2. 使用祈使语气（如"添加功能"而非"添加了功能"）
3. 首行不超过72个字符
4. 可选用表情符号前缀增强可读性：
   • 🎨 代码结构调整
   • 🐎 性能优化
   • 📝 文档更新
   • 🐛 问题修复
   • 🔥 代码删除
   • ✅ 测试添加

JavaScript/TypeScript 编码规范

1. 必须使用分号
2. 采用2空格缩进
3. 变量声明优先级：const > let，禁止使用var
4. 优先使用模板字符串而非字符串拼接
5. 命名规范：
   • 变量、属性和函数：camelCase
   • 类和Vue组件：PascalCase
   • 常量：UPPERCASE

Vue 组件开发规范

1. 严格遵循Vue官方风格指南
2. 使用单文件组件(SFC)形式
3. 组件名称必须为多单词组合
4. Prop定义需详细指定类型和验证规则
5. v-for指令必须配合key属性使用
6. 优先使用Composition API与<script setup>语法

CSS 样式规范

项目采用TailwindCSS工具集，开发时应：

1. 优先使用Tailwind提供的工具类
2. 避免编写自定义CSS
3. 如需扩展样式，应通过Tailwind配置进行

问题报告与功能建议

有效报告问题的要点

1. 重现步骤：提供清晰、可复现的操作流程
2. 环境信息：包括浏览器版本、扩展版本等
3. 预期与实际行为：明确描述差异
4. 附加信息：控制台日志、屏幕截图等

功能建议的要求

1. 场景描述：说明使用场景和用户需求
2. 解决方案：提出具体实现思路
3. 价值分析：阐述功能对大多数用户的价值

开发环境搭建

系统要求

• Node.js v22.14.0或更高版本
• PNPM v10.10.0或更高版本

本地开发流程

1. 克隆项目仓库
2. 创建特性分支
3. 安装依赖：pnpm install
4. 启动开发服务器：pnpm dev
5. 进行代码修改
6. 执行测试验证
7. 提交代码变更
8. 发起合并请求

测试与质量保证

1. 新功能必须包含对应测试用例
2. 修改现有代码需确保测试通过
3. 测试应覆盖主要使用场景和边界条件
4. 测试代码需与实现代码保持同步更新

文档要求

1. 新增API必须提供使用说明
2. 复杂逻辑需添加代码注释
3. 公共接口应包含类型定义
4. 配置项需说明各参数作用

项目标签系统

项目使用以下标签分类问题：

• bug：功能缺陷
• documentation：文档相关
• enhancement：功能增强
• help wanted：需要协助
• good first issue：新手友好任务

通过遵循这些规范，开发者可以确保代码质量的一致性，提高项目的可维护性和可扩展性。