workflow

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Standard Workflow

标准工作流

  1. First think through the problem, read the codebase for relevant files, and write a plan to specs/[timestamp] [feature-name].md where [timestamp] is the timestamp in YYYYMMDDThhmmss format and [feature-name] is the name of the feature.
  2. The plan should have a list of todo items that you can check off as you complete them
  3. Before you begin working, check in with me and I will verify the plan.
  4. Then, begin working on the todo items, marking them as complete as you go.
  5. Please every step of the way just give me a high level explanation of what changes you made
  6. Make every task and code change you do as simple as possible. We want to avoid making any massive or complex changes. Every change should impact as little code as possible. Everything is about simplicity.
  7. Finally, add a review section to the .md file with a summary of the changes you made and any other relevant information.
  1. 首先梳理问题,查阅代码库中的相关文件,然后编写规划文档并存放到specs/[timestamp] [feature-name].md,其中[timestamp]为YYYYMMDDThhmmss格式的时间戳,[feature-name]为功能名称。
  2. 规划文档中应包含待办事项列表,完成后可勾选标记
  3. 开始工作前,请与我确认,我会审核该规划文档。
  4. 随后,开始处理待办事项,完成一项标记一项。
  5. 请在每一步都向我简要说明你所做的变更
  6. 确保所有任务和代码变更尽可能简洁。我们要避免进行大规模或复杂的变更。每项变更应尽可能少地影响代码。一切以简洁为核心。
  7. 最后,在.md文件中添加一个评审部分,总结你所做的变更以及其他相关信息。

Spec Placement

规格文档存放位置

Specs always live at the root level of their scope (not inside
docs/
):
  • /specs/
    - Cross-cutting features, architecture decisions, general tooling
  • /apps/[app]/specs/
    - Features specific to one app only
  • /packages/[pkg]/specs/
    - Package-specific implementation details
When in doubt, use
/specs/
. Move to app/package-specific only if the spec truly belongs there.
规格文档始终存放在其作用域的根目录下(而非
docs/
内部):
  • /specs/
    - 跨模块功能、架构决策、通用工具相关文档
  • /apps/[app]/specs/
    - 仅针对单个应用的功能相关文档
  • /packages/[pkg]/specs/
    - 包专属的实现细节文档
若不确定存放位置,使用
/specs/
即可。仅当该规格文档确实属于某个应用/包时,再移至对应应用/包的专属目录。