@fitlab-ai/agent-infra 0.3.1 → 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (93) hide show
  1. package/README.md +29 -39
  2. package/README.zh-CN.md +29 -39
  3. package/bin/cli.js +1 -1
  4. package/lib/defaults.json +3 -12
  5. package/lib/init.js +13 -24
  6. package/lib/paths.js +3 -42
  7. package/lib/update.js +98 -32
  8. package/lib/version.js +2 -1
  9. package/package.json +2 -1
  10. package/templates/.agents/QUICKSTART.md +7 -7
  11. package/templates/.agents/QUICKSTART.zh-CN.md +7 -7
  12. package/templates/.agents/README.md +16 -4
  13. package/templates/.agents/README.zh-CN.md +16 -4
  14. package/templates/.agents/skills/analyze-task/SKILL.md +106 -105
  15. package/templates/.agents/skills/analyze-task/SKILL.zh-CN.md +6 -6
  16. package/templates/.agents/skills/block-task/SKILL.md +8 -8
  17. package/templates/.agents/skills/block-task/SKILL.zh-CN.md +8 -8
  18. package/templates/.agents/skills/check-task/SKILL.md +3 -3
  19. package/templates/.agents/skills/check-task/SKILL.zh-CN.md +3 -3
  20. package/templates/.agents/skills/close-codescan/SKILL.md +64 -63
  21. package/templates/.agents/skills/close-dependabot/SKILL.md +71 -70
  22. package/templates/.agents/skills/commit/SKILL.md +1 -1
  23. package/templates/.agents/skills/commit/SKILL.zh-CN.md +1 -1
  24. package/templates/.agents/skills/complete-task/SKILL.md +7 -7
  25. package/templates/.agents/skills/complete-task/SKILL.zh-CN.md +7 -7
  26. package/templates/.agents/skills/create-issue/SKILL.md +57 -12
  27. package/templates/.agents/skills/create-issue/SKILL.zh-CN.md +57 -12
  28. package/templates/.agents/skills/create-pr/SKILL.md +44 -7
  29. package/templates/.agents/skills/create-pr/SKILL.zh-CN.md +44 -7
  30. package/templates/.agents/skills/create-release-note/SKILL.md +18 -11
  31. package/templates/.agents/skills/create-release-note/SKILL.zh-CN.md +18 -11
  32. package/templates/.agents/skills/create-task/SKILL.md +80 -78
  33. package/templates/.agents/skills/create-task/SKILL.zh-CN.md +11 -10
  34. package/templates/.agents/skills/implement-task/SKILL.md +15 -18
  35. package/templates/.agents/skills/implement-task/SKILL.zh-CN.md +15 -18
  36. package/templates/.agents/skills/import-codescan/SKILL.md +54 -53
  37. package/templates/.agents/skills/import-codescan/SKILL.zh-CN.md +1 -1
  38. package/templates/.agents/skills/import-dependabot/SKILL.md +57 -56
  39. package/templates/.agents/skills/import-dependabot/SKILL.zh-CN.md +3 -3
  40. package/templates/.agents/skills/import-issue/SKILL.md +58 -58
  41. package/templates/.agents/skills/import-issue/SKILL.zh-CN.md +5 -5
  42. package/templates/.agents/skills/init-labels/SKILL.md +8 -0
  43. package/templates/.agents/skills/init-labels/SKILL.zh-CN.md +8 -0
  44. package/templates/.agents/skills/plan-task/SKILL.md +151 -149
  45. package/templates/.agents/skills/plan-task/SKILL.zh-CN.md +6 -6
  46. package/templates/.agents/skills/refine-task/SKILL.md +3 -3
  47. package/templates/.agents/skills/refine-task/SKILL.zh-CN.md +3 -3
  48. package/templates/.agents/skills/release/SKILL.md +55 -14
  49. package/templates/.agents/skills/release/SKILL.zh-CN.md +55 -14
  50. package/templates/.agents/skills/review-task/SKILL.md +9 -9
  51. package/templates/.agents/skills/review-task/SKILL.zh-CN.md +9 -9
  52. package/templates/.agents/skills/sync-issue/SKILL.md +258 -279
  53. package/templates/.agents/skills/sync-issue/SKILL.zh-CN.md +34 -56
  54. package/templates/.agents/skills/sync-pr/SKILL.md +8 -28
  55. package/templates/.agents/skills/sync-pr/SKILL.zh-CN.md +7 -27
  56. package/templates/.agents/skills/update-agent-infra/SKILL.md +6 -6
  57. package/templates/.agents/skills/update-agent-infra/SKILL.zh-CN.md +6 -6
  58. package/templates/.agents/skills/update-agent-infra/scripts/sync-templates.js +61 -116
  59. package/templates/.agents/templates/handoff.md +1 -1
  60. package/templates/.agents/templates/handoff.zh-CN.md +1 -1
  61. package/templates/.agents/workflows/bug-fix.yaml +71 -71
  62. package/templates/.agents/workflows/bug-fix.zh-CN.yaml +1 -1
  63. package/templates/.agents/workflows/feature-development.yaml +71 -71
  64. package/templates/.agents/workflows/feature-development.zh-CN.yaml +1 -1
  65. package/templates/.agents/workflows/refactoring.yaml +76 -76
  66. package/templates/.agents/workflows/refactoring.zh-CN.yaml +1 -1
  67. package/templates/{.agent-workspace → .agents/workspace}/README.md +1 -1
  68. package/templates/{.agent-workspace → .agents/workspace}/README.zh-CN.md +1 -1
  69. package/templates/.claude/CLAUDE.md +14 -1
  70. package/templates/.claude/CLAUDE.zh-CN.md +14 -1
  71. package/templates/.claude/hooks/check-version-format.sh +44 -0
  72. package/templates/.claude/settings.json +14 -0
  73. package/templates/.opencode/COMMAND_STYLE_GUIDE.md +6 -6
  74. package/templates/.opencode/COMMAND_STYLE_GUIDE.zh-CN.md +6 -6
  75. package/templates/AGENTS.md +14 -1
  76. package/templates/AGENTS.zh-CN.md +14 -1
  77. package/templates/.editorconfig +0 -15
  78. package/templates/.github/ISSUE_TEMPLATE/01_bug_report.yml +0 -149
  79. package/templates/.github/ISSUE_TEMPLATE/02_question.yml +0 -101
  80. package/templates/.github/ISSUE_TEMPLATE/03_feature_request.yml +0 -131
  81. package/templates/.github/ISSUE_TEMPLATE/04_documentation.yml +0 -165
  82. package/templates/.github/ISSUE_TEMPLATE/05_other.yml +0 -147
  83. package/templates/.github/ISSUE_TEMPLATE/config.yml +0 -11
  84. package/templates/.github/PULL_REQUEST_TEMPLATE.md +0 -123
  85. package/templates/.github/dependabot.yml +0 -17
  86. package/templates/.github/hooks/check-utf8-encoding.sh +0 -25
  87. package/templates/.github/release.yml +0 -27
  88. package/templates/.github/workflows/pr-title-check.yml +0 -42
  89. package/templates/.mailmap +0 -4
  90. package/templates/CONTRIBUTING.md +0 -126
  91. package/templates/CONTRIBUTING.zh-CN.md +0 -124
  92. package/templates/SECURITY.md +0 -131
  93. package/templates/SECURITY.zh-CN.md +0 -131
@@ -131,9 +131,9 @@ Status: active
131
131
  1. **验证任务存在**
132
132
 
133
133
  按以下顺序搜索任务文件:
134
- - `.agent-workspace/active/{task-id}/task.md`
135
- - `.agent-workspace/blocked/{task-id}/task.md`
136
- - `.agent-workspace/completed/{task-id}/task.md`
134
+ - `.agents/workspace/active/{task-id}/task.md`
135
+ - `.agents/workspace/blocked/{task-id}/task.md`
136
+ - `.agents/workspace/completed/{task-id}/task.md`
137
137
 
138
138
  如果未找到,回复:
139
139
  "任务 {task-id} 不存在,请检查任务 ID。"
@@ -157,9 +157,9 @@ Status: active
157
157
 
158
158
  ```markdown
159
159
  按以下顺序搜索任务:
160
- 1. `.agent-workspace/active/{task-id}/task.md`
161
- 2. `.agent-workspace/blocked/{task-id}/task.md`
162
- 3. `.agent-workspace/completed/{task-id}/task.md`
160
+ 1. `.agents/workspace/active/{task-id}/task.md`
161
+ 2. `.agents/workspace/blocked/{task-id}/task.md`
162
+ 3. `.agents/workspace/completed/{task-id}/task.md`
163
163
  ```
164
164
 
165
165
  ### 状态更新模式
@@ -63,7 +63,7 @@ Before submitting a PR, ensure:
63
63
  ## Security Notes
64
64
 
65
65
  - Do not commit sensitive files: `.env`, `credentials.json`, keys, etc.
66
- - Report security issues per `SECURITY.md` guidelines (do not open public Issues)
66
+ - Handle security issues privately according to your project's disclosure policy (do not open public Issues)
67
67
 
68
68
  ## Multi-AI Collaboration Support
69
69
 
@@ -86,6 +86,19 @@ All code-level content uses **English**. Documentation provides **multilingual v
86
86
 
87
87
  <!-- TODO: Add your project's tech stack here -->
88
88
 
89
+ ## Skill Authoring Conventions
90
+
91
+ When writing or updating `.agents/skills/*/SKILL.md` files, keep step numbering consistent:
92
+
93
+ 1. Use consecutive integers for top-level steps: `1.`, `2.`, `3.`.
94
+ 2. Use nested numbering only for child actions that belong to a parent step: `1.1`, `1.2`, `2.1`.
95
+ 3. Use `a`, `b`, and `c` markers for branches, conditions, or alternative paths within the same step.
96
+ 4. Do not use intermediate numbers such as `1.5` or `2.5`; if a new standalone step is needed, renumber the following top-level steps.
97
+ 5. When renumbering, update every in-document step reference so the instructions remain accurate.
98
+ 6. Extract long bash scripts into a sibling `scripts/` directory; the SKILL.md should contain only a single-line invocation (e.g., `bash .agents/skills/<skill>/scripts/<script>.sh`) and a brief summary of the script's responsibilities.
99
+
100
+ <!-- Canonical source: .agents/README.md - keep in sync -->
101
+
89
102
  ---
90
103
 
91
104
  **Based on standard**: [AGENTS.md](https://agents.md) (Linux Foundation AAIF)
@@ -63,7 +63,7 @@ refactor(module): refactor internal logic
63
63
  ## 安全注意事项
64
64
 
65
65
  - 不要提交敏感文件:`.env`, `credentials.json`, 密钥等
66
- - 安全问题请按 `SECURITY.md` 指引私下提交(不要公开 Issue)
66
+ - 安全问题请按项目自己的披露流程私下处理(不要公开 Issue)
67
67
 
68
68
  ## 多 AI 协作支持
69
69
 
@@ -86,6 +86,19 @@ refactor(module): refactor internal logic
86
86
 
87
87
  <!-- TODO: 在此添加你的项目技术栈 -->
88
88
 
89
+ ## Skill 编写规范
90
+
91
+ 编写或维护 `.agents/skills/*/SKILL.md` 时,步骤编号遵循以下规则:
92
+
93
+ 1. 顶级步骤使用连续整数:`1.`、`2.`、`3.`。
94
+ 2. 只有父步骤下的从属动作才使用子步骤:`1.1`、`1.2`、`2.1`。
95
+ 3. 同一步中的分支、条件或多种可能性使用 `a`、`b`、`c` 标记。
96
+ 4. 不要使用 `1.5`、`2.5` 这类中间编号;如新增独立步骤,应整体顺延后续编号。
97
+ 5. 调整编号时,必须同步更新文中的步骤引用,确保说明、命令和检查点一致。
98
+ 6. 长 bash 脚本应从 SKILL.md 提取到同级 `scripts/` 目录中,SKILL.md 只保留单行调用(如 `bash .agents/skills/<skill>/scripts/<script>.sh`)和对脚本职责的概要说明。
99
+
100
+ <!-- Canonical source: .agents/README.zh-CN.md - keep in sync -->
101
+
89
102
  ---
90
103
 
91
104
  **基于标准**: [AGENTS.md](https://agents.md) (Linux Foundation AAIF)
@@ -1,15 +0,0 @@
1
- root = true
2
-
3
- [*]
4
- charset = utf-8
5
- end_of_line = lf
6
- insert_final_newline = true
7
- trim_trailing_whitespace = true
8
- indent_style = space
9
- indent_size = 2
10
-
11
- [*.md]
12
- trim_trailing_whitespace = false
13
-
14
- [Makefile]
15
- indent_style = tab
@@ -1,149 +0,0 @@
1
- name: 🐛 问题报告 / Bug Report
2
- description: 报告项目中的错误或问题 / Report bugs or issues in the project
3
- labels:
4
- - "type: bug"
5
- - "status: waiting-for-triage"
6
- type: Bug
7
- body:
8
- - type: markdown
9
- attributes:
10
- value: |
11
- ## 感谢您提交问题报告!/ Thank you for submitting a bug report!
12
-
13
- 请尽可能详细地描述问题,这将帮助我们更快地定位和修复问题。
14
- Please describe the issue in as much detail as possible to help us locate and fix it faster.
15
-
16
- - type: input
17
- id: summary
18
- attributes:
19
- label: 问题摘要 / Issue Summary
20
- description: 用一句话简要描述这个问题 / Briefly describe this bug in one sentence
21
- placeholder: |
22
- 例如:执行某个操作后回调未触发
23
- Example: Callback not triggered after executing a specific operation
24
- validations:
25
- required: true
26
-
27
- - type: input
28
- id: version
29
- attributes:
30
- label: 版本信息 / Version Information
31
- description: 您使用的是哪个版本?/ Which version are you using?
32
- placeholder: "例如 / e.g.: v1.0.0"
33
- validations:
34
- required: true
35
-
36
- - type: input
37
- id: runtime
38
- attributes:
39
- label: 运行环境 / Runtime Environment
40
- description: 您使用的运行环境版本 / Your runtime environment version
41
- placeholder: "例如 / e.g.: Node.js 20.x, Python 3.12, JDK 17"
42
-
43
- - type: dropdown
44
- id: os
45
- attributes:
46
- label: 操作系统 / Operating System
47
- description: 您使用的操作系统 / Your operating system
48
- options:
49
- - "Windows 11"
50
- - "Windows 10"
51
- - "macOS (Intel)"
52
- - "macOS (Apple Silicon)"
53
- - "Ubuntu/Debian"
54
- - "Other Linux"
55
- - "其他 (请在下方说明) / Other (please specify below)"
56
-
57
- - type: textarea
58
- id: what-happened
59
- attributes:
60
- label: 发生了什么?/ What happened?
61
- description: |
62
- 详细描述问题的现象
63
- Describe the bug phenomenon in detail
64
- placeholder: |
65
- 告诉我们您看到了什么!
66
- Tell us what you saw!
67
-
68
- 例如 / Example:
69
- - 执行某个操作后,未得到预期的结果
70
- - After executing a specific operation, the expected result was not obtained
71
- validations:
72
- required: true
73
-
74
- - type: textarea
75
- id: expected
76
- attributes:
77
- label: 期望的行为 / Expected Behavior
78
- description: |
79
- 描述您期望发生什么
80
- Describe what you expected to happen
81
- placeholder: |
82
- 告诉我们您期望看到什么!
83
- Tell us what you expected to see!
84
-
85
- 例如 / Example:
86
- - 操作应该成功完成并返回正确的结果
87
- - The operation should complete successfully and return the correct result
88
- validations:
89
- required: true
90
-
91
- - type: textarea
92
- id: steps
93
- attributes:
94
- label: 重现步骤 / Steps to Reproduce
95
- description: |
96
- 如何重现这个问题?
97
- How to reproduce this issue?
98
- placeholder: |
99
- 1. 安装依赖 / Install dependencies
100
- 2. 配置 '...' / Configure '...'
101
- 3. 运行 '...' / Run '...'
102
- 4. 看到错误 / See error
103
- validations:
104
- required: true
105
-
106
- - type: textarea
107
- id: logs
108
- attributes:
109
- label: 相关日志 / Relevant Logs
110
- description: |
111
- 请复制粘贴任何相关的日志输出、错误信息或控制台输出
112
- Please copy and paste any relevant log output, error messages, or console output
113
-
114
- 这将自动格式化为代码块,无需使用反引号
115
- This will be automatically formatted as code block, no need for backticks
116
- render: shell
117
-
118
- - type: textarea
119
- id: additional-context
120
- attributes:
121
- label: 额外信息 / Additional Context
122
- description: |
123
- 添加任何其他有助于解决问题的信息,如截图、相关链接等
124
- Add any other information that might help solve the issue, such as screenshots, related links, etc.
125
-
126
- - type: checkboxes
127
- id: terms
128
- attributes:
129
- label: 确认事项 / Confirmations
130
- description: |
131
- 提交前请确认以下事项
132
- Please confirm the following before submitting
133
- options:
134
- - label: |
135
- 我已经搜索了现有的issues,确认这不是重复问题
136
- I have searched existing issues and confirmed this is not a duplicate
137
- required: true
138
- - label: |
139
- 我已经阅读了项目文档和 FAQ
140
- I have read the project documentation and FAQ
141
- required: true
142
- - label: |
143
- 我提供的信息准确完整
144
- The information I provided is accurate and complete
145
- required: true
146
- - label: |
147
- 我愿意协助测试问题修复 (可选)
148
- I'm willing to help test the bug fix (optional)
149
- required: false
@@ -1,101 +0,0 @@
1
- name: ❓ 问题咨询 / Question
2
- description: 询问使用相关的问题 / Ask usage-related questions
3
- labels:
4
- - "type: question"
5
- - "status: waiting-for-triage"
6
- type: Task
7
- body:
8
- - type: markdown
9
- attributes:
10
- value: |
11
- ## 提问前请先查看 / Please check before asking
12
-
13
- - 📚 项目文档 / Documentation
14
- - ❓ 常见问题 / FAQ
15
- 如果文档中没有找到答案,请详细描述您的问题。
16
- If you can't find the answer in the documentation, please describe your question in detail.
17
-
18
- - type: input
19
- id: summary
20
- attributes:
21
- label: 问题摘要 / Question Summary
22
- description: |
23
- 简要描述您的问题
24
- Briefly describe your question
25
- placeholder: |
26
- 例如:如何正确配置项目?
27
- Example: How to configure the project correctly?
28
- validations:
29
- required: true
30
-
31
- - type: dropdown
32
- id: category
33
- attributes:
34
- label: 问题类别 / Question Category
35
- description: |
36
- 您的问题属于哪个类别?
37
- Which category does your question belong to?
38
- options:
39
- - 安装配置 / Installation & Configuration
40
- - 使用教程 / Usage Tutorial
41
- - "API相关 / API Related"
42
- - 故障排除 / Troubleshooting
43
- - 最佳实践 / Best Practices
44
- - 性能相关 / Performance Related
45
- - 集成问题 / Integration Issues
46
- - 其他 / Other
47
- validations:
48
- required: true
49
-
50
- - type: textarea
51
- id: question
52
- attributes:
53
- label: 详细问题 / Detailed Question
54
- description: |
55
- 详细描述您遇到的问题,包括:
56
- - 您想要实现什么
57
- - 您尝试了什么方法
58
- - 遇到了什么困难
59
-
60
- Describe your problem in detail, including:
61
- - What you want to achieve
62
- - What methods you tried
63
- - What difficulties you encountered
64
- placeholder: |
65
- 我想要... / I want to...
66
- 我尝试了... / I tried...
67
- 但是遇到了... / But I encountered...
68
- validations:
69
- required: true
70
-
71
- - type: textarea
72
- id: context
73
- attributes:
74
- label: 环境信息 / Environment Information
75
- description: |
76
- 提供相关的环境信息 / Provide relevant environment information
77
- placeholder: |
78
- - 操作系统 / OS: (例如 Windows 11, macOS 13, Ubuntu 20.04)
79
- - 运行环境版本 / Runtime Version: (例如 Node.js v20.11.0)
80
- - 项目版本 / Project Version: (例如 v0.1.0)
81
- - 其他相关信息 / Other relevant info:
82
-
83
- - type: checkboxes
84
- id: checklist
85
- attributes:
86
- label: 确认事项 / Checklist
87
- description: |
88
- 提交前请确认 / Please confirm before submitting
89
- options:
90
- - label: |
91
- 我已经查看了项目文档
92
- I have read the project documentation
93
- required: true
94
- - label: |
95
- 我已经搜索了相关 issues 和讨论
96
- I have searched related issues and discussions
97
- required: true
98
- - label: |
99
- 我已经尝试了基本的故障排除步骤
100
- I have tried basic troubleshooting steps
101
- required: true
@@ -1,131 +0,0 @@
1
- name: ✨ 功能请求 / Feature Request
2
- description: 建议一个新功能或改进 / Suggest a new feature or improvement
3
- labels:
4
- - "type: feature"
5
- - "status: waiting-for-internal-feedback"
6
- type: Feature
7
- body:
8
- - type: markdown
9
- attributes:
10
- value: |
11
- ## 感谢您的功能建议!/ Thank you for your feature suggestion!
12
-
13
- 请详细描述您的想法,这将帮助我们更好地理解和评估您的建议。
14
- Please describe your idea in detail to help us better understand and evaluate your suggestion.
15
-
16
- - type: input
17
- id: summary
18
- attributes:
19
- label: 功能摘要 / Feature Summary
20
- description: |
21
- 用一句话描述您想要的功能
22
- Describe the feature you want in one sentence
23
- placeholder: |
24
- 例如:支持自动检测并应用最佳配置
25
- Example: Support automatic detection and application of optimal configuration
26
- validations:
27
- required: true
28
-
29
- - type: dropdown
30
- id: feature-type
31
- attributes:
32
- label: 功能类型 / Feature Type
33
- description: |
34
- 这是什么类型的功能请求?
35
- What type of feature request is this?
36
- options:
37
- - 全新功能 / New Feature
38
- - 用户体验改进 / UX Improvement
39
- - 性能优化 / Performance Optimization
40
- - "API改进 / API Enhancement"
41
- - 文档改进 / Documentation Improvement
42
- - 安全性增强 / Security Enhancement
43
- - 工具集成 / Tooling Integration
44
- - 其他 / Other
45
- validations:
46
- required: true
47
-
48
- - type: dropdown
49
- id: priority
50
- attributes:
51
- label: 优先级 / Priority
52
- description: |
53
- 您认为这个功能的重要程度如何?
54
- How important do you think this feature is?
55
- options:
56
- - 高 - 非常需要这个功能 / High - Really need this feature
57
- - 中 - 有了更好 / Medium - Would be nice to have
58
- - 低 - 可有可无 / Low - Optional
59
- validations:
60
- required: true
61
-
62
- - type: textarea
63
- id: problem
64
- attributes:
65
- label: 问题描述 / Problem Description
66
- description: |
67
- 这个功能要解决什么问题?为什么需要这个功能?
68
- What problem does this feature solve? Why is this feature needed?
69
- placeholder: |
70
- 我遇到的问题是... / The problem I encountered is...
71
-
72
- 例如 / Example:
73
- - 当前需要手动执行的操作太多,希望能自动化
74
- - Currently too many manual operations are required, hoping to automate them
75
- validations:
76
- required: true
77
-
78
- - type: textarea
79
- id: solution
80
- attributes:
81
- label: 建议的解决方案 / Proposed Solution
82
- description: |
83
- 您希望如何解决这个问题?详细描述您设想的功能。
84
- How would you like to solve this problem? Describe the feature you envision in detail.
85
- placeholder: |
86
- 我认为可以通过...来解决 / I think this can be solved by...
87
-
88
- 例如 / Example:
89
- - 添加一个配置选项来控制自动化行为
90
- - Add a configuration option to control automated behavior
91
- validations:
92
- required: true
93
-
94
- - type: textarea
95
- id: alternatives
96
- attributes:
97
- label: 替代方案 / Alternative Solutions
98
- description: |
99
- 您考虑过其他解决方案吗?
100
- Have you considered any alternative solutions?
101
- placeholder: |
102
- 我也考虑过... / I also considered...
103
-
104
- 例如 / Example:
105
- - 使用外部工具来实现类似功能
106
- - Using external tools to achieve similar functionality
107
-
108
- - type: checkboxes
109
- id: confirmations
110
- attributes:
111
- label: 确认事项 / Confirmations
112
- description: |
113
- 提交前请确认以下事项
114
- Please confirm the following before submitting
115
- options:
116
- - label: |
117
- 我已经搜索了现有的 issues 和讨论,确认这不是重复建议
118
- I have searched existing issues and discussions, confirming this is not a duplicate suggestion
119
- required: true
120
- - label: |
121
- 这个功能符合项目的目标和范围
122
- This feature aligns with the project's goals and scope
123
- required: true
124
- - label: |
125
- 我理解这个功能可能需要时间来实现
126
- I understand this feature may take time to implement
127
- required: true
128
- - label: |
129
- 我愿意协助实现这个功能 (可选)
130
- I'm willing to help implement this feature (optional)
131
- required: false
@@ -1,165 +0,0 @@
1
- name: 📚 文档问题 / Documentation Issue
2
- description: 报告文档中的错误、缺失或改进建议 / Report documentation errors, missing content, or improvement suggestions
3
- labels:
4
- - "type: documentation"
5
- - "status: waiting-for-triage"
6
- type: Task
7
- body:
8
- - type: markdown
9
- attributes:
10
- value: |
11
- ## 感谢您帮助改进文档!/ Thank you for helping improve the documentation!
12
-
13
- 好的文档对项目至关重要。请详细描述文档问题,帮助我们提供更好的文档体验。
14
- Good documentation is crucial for the project. Please describe the documentation issue in detail to help us provide a better documentation experience.
15
-
16
- - type: input
17
- id: summary
18
- attributes:
19
- label: 问题摘要 / Issue Summary
20
- description: 用一句话简要描述文档问题 / Briefly describe the documentation issue in one sentence
21
- placeholder: |
22
- 例如:API文档中缺少某个配置参数说明
23
- Example: Missing configuration parameter description in API documentation
24
- validations:
25
- required: true
26
-
27
- - type: dropdown
28
- id: doc-type
29
- attributes:
30
- label: 文档类型 / Documentation Type
31
- description: 这个问题涉及哪种类型的文档?/ Which type of documentation does this issue involve?
32
- options:
33
- - "README文件 / README file"
34
- - "API文档 / API Documentation"
35
- - "安装指南 / Installation Guide"
36
- - "使用教程 / Usage Tutorial"
37
- - "配置说明 / Configuration Guide"
38
- - "故障排除 / Troubleshooting"
39
- - "贡献指南 / Contributing Guide"
40
- - "更新日志 / Changelog"
41
- - "代码注释 / Code Comments"
42
- - "其他 (请在下方说明) / Other (please specify below)"
43
- validations:
44
- required: true
45
-
46
- - type: dropdown
47
- id: issue-type
48
- attributes:
49
- label: 问题类型 / Issue Type
50
- description: 这是什么类型的文档问题?/ What type of documentation issue is this?
51
- options:
52
- - "内容错误 / Content Error"
53
- - "信息缺失 / Missing Information"
54
- - "过时内容 / Outdated Content"
55
- - "格式问题 / Formatting Issue"
56
- - "链接失效 / Broken Link"
57
- - "翻译问题 / Translation Issue"
58
- - "结构改进 / Structure Improvement"
59
- - "示例代码问题 / Example Code Issue"
60
- - "其他 / Other"
61
- validations:
62
- required: true
63
-
64
- - type: input
65
- id: location
66
- attributes:
67
- label: 文档位置 / Document Location
68
- description: |
69
- 请提供具体的文档位置信息
70
- Please provide specific document location information
71
- placeholder: |
72
- 例如:docs/api.md 第15行,或者 README.md 的"安装"部分
73
- Example: Line 15 in docs/api.md, or "Installation" section in README.md
74
- validations:
75
- required: true
76
-
77
- - type: textarea
78
- id: current-content
79
- attributes:
80
- label: 当前内容 / Current Content
81
- description: |
82
- 复制粘贴当前有问题的文档内容(如果适用)
83
- Copy and paste the current problematic documentation content (if applicable)
84
- placeholder: |
85
- 请粘贴当前的文档内容...
86
- Please paste the current documentation content...
87
- render: markdown
88
-
89
- - type: textarea
90
- id: issue-description
91
- attributes:
92
- label: 问题描述 / Issue Description
93
- description: |
94
- 详细描述文档问题
95
- Describe the documentation issue in detail
96
- placeholder: |
97
- 详细说明问题所在... / Explain the issue in detail...
98
-
99
- 例如 / Example:
100
- - 这段文档与实际功能不符
101
- - This documentation doesn't match the actual functionality
102
- - 缺少必要的参数说明
103
- - Missing necessary parameter descriptions
104
- validations:
105
- required: true
106
-
107
- - type: textarea
108
- id: suggested-content
109
- attributes:
110
- label: 建议的内容 / Suggested Content
111
- description: |
112
- 如果您有改进建议,请提供修正后的内容
113
- If you have improvement suggestions, please provide the corrected content
114
- placeholder: |
115
- 建议的文档内容... / Suggested documentation content...
116
- render: markdown
117
-
118
- - type: textarea
119
- id: impact
120
- attributes:
121
- label: 影响范围 / Impact
122
- description: |
123
- 这个文档问题对用户有什么影响?
124
- What impact does this documentation issue have on users?
125
- placeholder: |
126
- 这个问题可能导致... / This issue might cause...
127
-
128
- 例如 / Example:
129
- - 用户无法正确配置项目
130
- - Users cannot configure the project correctly
131
- - 开发者集成时遇到困难
132
- - Developers encounter difficulties during integration
133
-
134
- - type: textarea
135
- id: additional-context
136
- attributes:
137
- label: 额外信息 / Additional Context
138
- description: |
139
- 添加任何其他有助于改进文档的信息,如截图、相关链接等
140
- Add any other information that might help improve the documentation, such as screenshots, related links, etc.
141
-
142
- - type: checkboxes
143
- id: confirmations
144
- attributes:
145
- label: 确认事项 / Confirmations
146
- description: |
147
- 提交前请确认以下事项
148
- Please confirm the following before submitting
149
- options:
150
- - label: |
151
- 我已经搜索了现有的文档相关issues,确认这不是重复问题
152
- I have searched existing documentation-related issues and confirmed this is not a duplicate
153
- required: true
154
- - label: |
155
- 我已经仔细阅读了相关的文档内容
156
- I have carefully read the relevant documentation content
157
- required: true
158
- - label: |
159
- 我提供的信息准确完整
160
- The information I provided is accurate and complete
161
- required: true
162
- - label: |
163
- 我愿意协助改进文档内容 (可选)
164
- I'm willing to help improve the documentation content (optional)
165
- required: false