General Development Skills 是一份通用软件开发实践的技能文档,来源为 violabg/dev-recruit,可通过 https://www.skills.sh/violabg/dev-recruit/general-development 获取。它围绕软件开发的三个核心环节——代码审查、测试策略与 CI/CD 集成,给出可操作的流程建议与检查清单。
一、用途 该技能用于在实现功能、编写测试、配置持续集成与部署等日常开发活动中提供实践参考,帮助团队维护代码质量、保障应用可靠性并加快发布节奏。资料将其定位为核心软件开发工作流的最佳实践集合。
二、主要能力
- 代码审查实践:以维护代码质量与知识共享为目的,给出审查流程(尽量在 24 小时内审阅 PR、检查逻辑错误与边界情况、确认新功能包含测试、确保文档在需要时更新)、反馈方式(使用建设性语言与具体建议、肯定做得好的部分、以提问代替假设、仅对关键问题要求修改而对非阻塞问题提出改进建议)以及审查清单(遵循项目风格指南与约定、变更经过充分测试、文档完整、无硬编码凭据或敏感数据、考虑性能影响、依赖必要且保持更新)。示例中列举了审查功能分支时应确认的要点:所有测试通过、代码覆盖率未下降、无遗留 console.log、类型安全得到保持。
- 测试策略:以保障应用可靠性、防止回归为目的,划分三个测试层级。单元测试针对独立函数与组件,对外部依赖使用 mock,追求业务逻辑的高覆盖率并保持测试聚焦可读;集成测试验证组件交互与数据流、以真实数据检验 API 端点、测试数据库操作与查询、检查跨组件错误处理;端到端测试覆盖关键用户旅程、使用浏览器自动化进行 UI 测试、验证从输入到输出的完整流程,并保持 E2E 测试精简聚焦。最佳实践包括:开发过程中与代码同步编写测试、使用能说明测试内容的描述性命名、在保持清晰的前提下让测试 DRY、推送前本地运行测试、维护测试数据夹具。
- CI/CD 集成:以自动化代码质量检查与部署流程、实现更快更安全的发布为目的,划分流水线阶段。构建阶段编译/转译代码、生成构建产物、编译错误时快速失败;测试阶段运行单元与集成测试、执行 lint 与代码质量检查、生成覆盖率报告、未达覆盖率阈值即失败;安全阶段扫描依赖漏洞、检查代码中的密钥、执行静态分析;部署阶段针对预发环境运行 E2E 测试、部署到预发环境、运行冒烟测试、部署到生产(必要时需审批)。推荐工具包括 GitHub Actions(CI/CD 编排)、ESLint(代码 lint)、Vitest/Jest(测试)、SonarQube(代码质量指标)、Dependabot(依赖更新)。示例工作流为:触发条件为推送到 main 或打开 PR,随后依次执行安装依赖与编译、运行 ESLint 与格式检查、运行单元与集成测试、扫描依赖、部署到预发/生产(需审批)。
三、使用方式 资料未提供该技能的具体安装命令、调用接口或代码示例,仅以文档形式描述实践规范,因此实际接入与执行方式暂未提供。
四、适用场景 适用于实现新功能、编写测试、配置持续集成流水线等通用软件开发场景,尤其适合需要统一代码审查标准、建立分层测试体系与自动化发布流程的团队参考。
五、限制 资料仅提供实践指引与清单,未说明其运行环境、依赖条件、支持的语言或框架范围;工具推荐仅列出名称,未给出具体版本、收费情况或配置细节,上述信息暂未提供。