code
Compare original and translation side by side
🇺🇸
Original
English🇨🇳
Translation
ChineseCode
代码
This skill is a step of feature development.
This skill actually implements a Feature or a Fix in the codebase.
Terminology:
- A Feature is an new capability provided by the project. It must always be described in its own markdown file in the codebase.
- An Fix refers to something that needs to be changed in the codebase. It is more granular than a Feature, it is not described in its own markdown file and is often related to something that was either left behind or a bug that was noticed. It must always be linked to a Github issue.
本Skill是功能开发的一个步骤。
本Skill用于在代码库中实际实现Feature(功能)或Fix(修复)。
术语定义:
- Feature指项目提供的新功能。它必须始终在代码库中单独的markdown文件中进行描述。
- Fix指需要在代码库中修改的内容。它比Feature更细化,不需要在单独的markdown文件中描述,通常与遗漏的内容或发现的bug相关。它必须始终关联到一个Github issue。
Starting point
起始条件
The starting point is always either a Feature or an Fix and a Plan consisting of a list of Tasks for the implementation.
You MUST have all of these to proceed with any implementation.
Checklist to begin:
If this checklist is not all satisfied you must not and are not allowed to start the implementation:
- You have a Feature or a Fix to work on.
- [ ] You have a plan with a list of tasks related to what needs to be implemented.
- You know which codebase (project, repo) you are working on.
- [ ] You know which Github issue you are working against
起始点必须是一个Feature或Fix,以及包含任务列表的实施计划。
你必须具备所有这些条件才能开始实施。
启动检查清单:
如果以下清单未全部满足,你不得且不允许开始实施:
- 你有需要处理的Feature或Fix。
- [ ] 你有包含待实现相关任务列表的计划。
- 你清楚自己正在操作的代码库(项目、仓库)。
- [ ] 你清楚自己正在处理的Github issue编号。
The Workflow
工作流程
You must always strictly follow this workflow when implementing a feature:
- Read the task list (plan) that is your starting point.
- Take one task at a time, starting from those that depend on no other tasks and proceeding according to dependencies.
2.1. Implement the task
- If the task is related to building (or changing) a frontend (UI) component, use the skill. You must use this skill. - If the task is related to building (or changing) a backend microservice, a function (method) or a component that is not a frontend (UI) component, you MUST: - [ ] use the
frontend-developmentskill. You must use this skill - [ ] read and follow the coding guidelines for microservices available at the repotest-driven-development. You MUST follow these guidelines. 2.2. Commit.nicolasances/sdlc-agent-specs/coding-standards/toto-microservice-development.md - Make a report of the implemented tasks.
在实现功能时,你必须严格遵循以下工作流程:
- 作为起始点,先阅读任务列表(计划)。
- 一次处理一个任务,从无依赖的任务开始,按照依赖关系推进。
2.1. 实现任务
- 如果任务涉及构建(或修改)前端(UI)组件,请使用Skill。你必须使用该Skill。 - 如果任务涉及构建(或修改)后端微服务、函数(方法)或非前端(UI)组件,你必须: - [ ] 使用
frontend-developmentSkill。你必须使用该Skill - [ ] 阅读并遵循仓库test-driven-development中提供的微服务编码指南。你必须遵循这些指南。 2.2. 提交代码。nicolasances/sdlc-agent-specs/coding-standards/toto-microservice-development.md - 编写已完成任务的报告。
Rules
规则
Structure of the final report:
| Task | Short Description | Commit Id |
Rules for implementation:
- You MUST always code in the feature branch you have created in the previous phase.
- Whenever the task (implementation) involves a change to the project you MUST follow this worklow:
toto-react- Switch the frontend that uses to Local Mode. You MUST use the
toto-reactskill for that.switching-toto-react-mode - Implement the changes
- Switch back to Package Mode. Again, you MUST use the skill for that.
switching-toto-react-mode
- Switch the frontend that uses
Adhere to my Coding Standards:
- When coding in python, you MUST first read the instructions in the
coding-standards/python-coding-standards.mdGitHub repo.nicolasances/sdlc-agent-specs - When coding in typescript (NodeJS), you MUST first read the instructions in the
coding-standards/node-coding-standards.mdGitHub repo.nicolasances/sdlc-agent-specs - When building a microservice (i.e. a backend microservice), you MUST first read the instructions in the
coding-standards/toto-microservice-development.mdGitHub repo.nicolasances/sdlc-agent-specs
最终报告结构:
| 任务 | 简短描述 | 提交ID |
实施规则:
- 你必须始终在之前阶段创建的功能分支中编写代码。
- 当任务(实施)涉及修改项目时,你必须遵循以下工作流程:
toto-react- 将使用的前端切换为本地模式。你必须使用
toto-reactSkill来完成此操作。switching-toto-react-mode - 实现修改
- 切换回包模式。同样,你必须使用Skill来完成此操作。
switching-toto-react-mode
- 将使用
遵守编码标准:
- 当使用Python编码时,你必须先阅读GitHub仓库中
nicolasances/sdlc-agent-specs的说明。coding-standards/python-coding-standards.md - 当使用TypeScript(NodeJS)编码时,你必须先阅读GitHub仓库中
nicolasances/sdlc-agent-specs的说明。coding-standards/node-coding-standards.md - 当构建后端微服务时,你必须先阅读GitHub仓库中
nicolasances/sdlc-agent-specs的说明。coding-standards/toto-microservice-development.md
Acceptance Criteria
验收标准
- [ ] You have used either the skill or the
front-end-developmentskill to implement the feature, or both, depending on the type of change you're making.test-driven-development - If making changes to , you have used the
toto-reactskill.switch-toto-react-mode - [ ] You have made the final report on implemented tasks. All tasks have a commit Id.
RED FLAGS:
- You are modifying frontend UI code without using the skill
front-end-development - You are modifying backend code or frontend non-UI code (e.g. core logic) without implmenting tests using the skill
test-driven-development - You are building a backend microservice without having read the instructions in the
coding-standards/toto-microservice-development.mdGitHub repo.nicolasances/sdlc-agent-specs - You have a single big commit that contains all the changes for an issue instead of multiple smaller commits that each represent a logical increment of work.
- You are making a change to without having used the
toto-reactskill.switch-toto-react-mode - There is no final report
- [ ] 根据你所做的修改类型,你已使用Skill或
front-end-developmentSkill,或两者都使用。test-driven-development - 如果修改,你已使用
toto-reactSkill。switch-toto-react-mode - [ ] 你已编写已完成任务的最终报告。所有任务都有对应的提交ID。
警示信号:
- 你在未使用Skill的情况下修改前端UI代码。
front-end-development - 你在未使用Skill编写测试的情况下修改后端代码或前端非UI代码(例如核心逻辑)。
test-driven-development - 你在未阅读GitHub仓库中
nicolasances/sdlc-agent-specs说明的情况下构建后端微服务。coding-standards/toto-microservice-development.md - 你使用单个大提交包含一个issue的所有修改,而非使用多个较小的提交分别代表工作的逻辑增量。
- 你在未使用Skill的情况下修改
switch-toto-react-mode。toto-react - 未生成最终报告。