docs(repo): add readme and issue templates
This commit is contained in:
62
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
62
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
@@ -0,0 +1,62 @@
|
||||
name: Bug Report
|
||||
description: 报告一个可复现的缺陷、回归或运行异常
|
||||
title: "[Bug] "
|
||||
labels:
|
||||
- bug
|
||||
body:
|
||||
- type: textarea
|
||||
id: summary
|
||||
attributes:
|
||||
label: 问题描述
|
||||
description: 简洁说明问题是什么,影响了什么。
|
||||
placeholder: 描述实际发生的问题。
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: reproduce
|
||||
attributes:
|
||||
label: 复现步骤
|
||||
description: 用最短路径说明如何稳定复现。
|
||||
placeholder: |
|
||||
1. 执行 ...
|
||||
2. 调用 ...
|
||||
3. 观察 ...
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: expected
|
||||
attributes:
|
||||
label: 预期结果
|
||||
placeholder: 描述本来应该发生的行为。
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: actual
|
||||
attributes:
|
||||
label: 实际结果
|
||||
placeholder: 描述实际发生的行为、错误码、异常输出。
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: env
|
||||
attributes:
|
||||
label: 环境信息
|
||||
description: 尽量包含分支、提交号、配置模式、数据库模式、平台适配模式。
|
||||
placeholder: |
|
||||
commit: ...
|
||||
env: development/test/production
|
||||
postgres: enabled/disabled
|
||||
adapter: sub2api/newapi/off
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: logs
|
||||
attributes:
|
||||
label: 日志 / 截图 / 失败输出
|
||||
description: 粘贴最关键的片段,不要只说“报错了”。
|
||||
render: shell
|
||||
8
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
8
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
@@ -0,0 +1,8 @@
|
||||
blank_issues_enabled: false
|
||||
contact_links:
|
||||
- name: Platform callback runbook
|
||||
url: https://github.com/phamnazage-jpg/ai-customer-service/blob/main/docs/RUNBOOK_PLATFORM_CALLBACKS.md
|
||||
about: 先看 callback 排障与重放说明,再决定是否提 issue。
|
||||
- name: Config contract baseline
|
||||
url: https://github.com/phamnazage-jpg/ai-customer-service/blob/main/docs/CONFIG_CONTRACT_BASELINE.md
|
||||
about: 配置、环境变量和运行参数以这里为准。
|
||||
63
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Normal file
63
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Normal file
@@ -0,0 +1,63 @@
|
||||
name: Feature Request
|
||||
description: 提出新的功能、适配增强、运维能力或产品需求
|
||||
title: "[Feature] "
|
||||
labels:
|
||||
- enhancement
|
||||
body:
|
||||
- type: textarea
|
||||
id: background
|
||||
attributes:
|
||||
label: 背景与目标
|
||||
description: 说明为什么需要这个能力,它解决什么问题。
|
||||
placeholder: 描述业务背景、技术背景或当前痛点。
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: proposal
|
||||
attributes:
|
||||
label: 建议方案
|
||||
description: 说明你希望系统怎么表现,尽量写清边界。
|
||||
placeholder: 描述期望的接口、配置、行为或交付结果。
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: scope
|
||||
attributes:
|
||||
label: 范围与非目标
|
||||
description: 说明这次应该做什么,不应该顺手做什么。
|
||||
placeholder: |
|
||||
In scope:
|
||||
- ...
|
||||
Out of scope:
|
||||
- ...
|
||||
|
||||
- type: textarea
|
||||
id: acceptance
|
||||
attributes:
|
||||
label: 验收标准
|
||||
description: 给出可验证的完成标准。
|
||||
placeholder: |
|
||||
1. ...
|
||||
2. ...
|
||||
3. ...
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: dropdown
|
||||
id: area
|
||||
attributes:
|
||||
label: 影响范围
|
||||
options:
|
||||
- Webhook ingress
|
||||
- Dialog / ticket flow
|
||||
- Sub2API adapter
|
||||
- NewAPI adapter
|
||||
- Callback delivery
|
||||
- PostgreSQL / schema
|
||||
- Docs / runbook
|
||||
- QA / verification
|
||||
- Other
|
||||
validations:
|
||||
required: true
|
||||
Reference in New Issue
Block a user