Skip to main content

​
为团队构建自定义指令

创建标准化的项目指令确保所有团队成员在一致的指导原则内工作。首先记录项目的技术基础，然后确定需要包含在指令中的信息。确切的范围会根据团队的需求而有所不同，但通常最好提供尽可能多的信息。通过创建所有团队成员都遵循的全面指令，您可以建立对代码应该如何编写、测试和部署的共同理解，从而产生更易维护和一致的软件。
以下是您团队自定义指令需要考虑的一些主题和示例：
  1. 测试框架和特定命令
    • “所有组件必须包含至少 85% 覆盖率的 Jest 测试。在提交任何拉取请求之前，使用 npm run test:coverage 运行测试。”
  2. 明确的库偏好
    • “使用 React Query 进行数据获取和状态管理。除非复杂的全局状态特别需要，否则避免使用 Redux。对于样式，使用 Tailwind CSS 和我们在 src/styles/theme.js 中找到的自定义主题配置。”
  3. 在哪里找到文档
    • “所有 API 文档都在我们的内部 Notion 工作空间中的’工程 > API 参考’下可用。有关组件使用示例，请参阅我们在 https://storybook.internal.company.com 的 Storybook 实例”
  4. 使用哪些 MCP 服务器，以及用于什么目的
    • “对于数据库操作，使用存储在 1Password 的’开发 > 数据库’下凭据的 Postgres MCP 服务器。对于部署，使用需要来自 IAM 的部署角色的 AWS MCP 服务器。有关配置说明，请参阅 docs/mcp-setup.md。”
  5. 特定于您项目的编码约定
    • “使用 PascalCase 命名所有 React 组件，使用 camelCase 命名所有辅助函数。将组件按功能而不是类型放在 src/components 目录中。始终为属性定义使用 TypeScript 接口。”