refactor: add TaskFlow.Contracts for error codes and enums

未关闭
  • 哪里不对？
#399 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
43/100
Issue 类型
重构
描述清晰度
基本清楚
活跃度
活跃
技术栈
csharp, docker
领域
backend-api-design, build-system, ci-cd, testing

调研方向

Start by checking #398, which blocks this issue, then inspect TaskRuleErrors.cs, TaskItemsController, ToolGuard, and TaskFlow.Api/Dockerfile to confirm the existing error codes and project references. Review the API and MCP project files and deployment workflow to identify required changes. Done when the reflection test covers every code, the API image builds, npm run gen:api produces no unwanted changes, changes to TaskFlow.Contracts trigger API deployment, and plugin/bin contains no EF Core assemblies.

由索引模型根据 Issue 内容生成。

描述

tech-debt

Part of #397. Blocked by #398.

Problem

The API has about 18 distinct machine-readable error codes (from a pattern search; confirm the list when centralising them). ToolGuard maps 5. Only 3 are in TaskRuleErrors.cs; others, such as TASK_START_NOT_ALLOWED, are defined in TaskItemsController. A new code reaches users with no specific guidance, and nothing flags it.

Scope

  • Add a TaskFlow.Contracts project at the repo root, referenced by TaskFlow.Api and TaskFlow.Mcp. It has no EF Core or ASP.NET dependencies.
  • Move every error code into it as a constant. Leave the response bodies in the API.
  • Move Status and Priority into it. Decide whether the MCP server adopts the enums or keeps strings, based on the size of that migration.
  • Add a reflection test: each code must be mapped in ToolGuard or appear on an explicit "no message needed" list.
  • Update TaskFlow.Api/Dockerfile to copy the new project before restore and publish.

Out of scope

Sharing DTOs and business rules such as IsBlockable.

Acceptance criteria

  1. Adding a new error code without a mapping or list entry fails a test.
  2. The API image builds, and the generated web client has no unwanted changes after npm run gen:api.
  3. A change to TaskFlow.Contracts deploys the API, because it sits outside the assistant/** ignore.
  4. plugin/bin contains no EF Core assemblies.
主要语言
C#
星标
1
派生
0
平均合并
2 小时 2 分钟
30 天内合并 PR
98

环境准备

  • 提供 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

  1. 先读完整个 Issue，再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库，在一个分支上完成修改。
  4. 提交 Pull Request，并在描述里引用这个 Issue 编号。

nevridge/TaskFlow 的其他 Issue

查看 nevridge/TaskFlow 的全部 Issue

相似的 Issue

更多 C# Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。