mcpField
S
simple-issue-description

simple-issue-description

github.com/every-app开发25.5k3.9k 次安装2 天前更新
代码仓库

关于 simple-issue-description

一项将笔记、对话、Issue、PR 或差异内容整理为简洁问题报告的写作技能，聚焦行为表现，并区分缺陷与功能请求；信息不足时会先请求澄清。

主要功能

  1. 01撰写简洁的问题报告
  2. 02聚焦实际行为表现
  3. 03区分缺陷与功能请求
  4. 04指出不明确或缺乏依据的内容

适用场景

  1. 01将对话整理为 Issue
  2. 02描述 PR 中试图解决的问题
  3. 03判断代码变更是否有充分的问题依据

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/every-app/open-seo --skill simple-issue-description

安装后在 Claude Code 中输入/simple-issue-description确认已加载。

附带文件agents/openai.yaml

详细介绍

简明问题描述

撰写一份维护者在不到一分钟内就能理解的问题描述。重点说明用户遇到了什么，以及预期行为是什么。

工作流程

  1. 阅读提供的说明、对话、问题、PR 描述或差异内容。对于 PR，还要检查规范、设计文档或 README 是否有变更——它们通常比描述更能说明意图。
  2. 找出具体问题。如果来源中有明确说明，请指出受影响的用户或对象。
  3. 描述期望的行为，不要规定实现方式。
  4. 只保留有助于理解或复现问题的背景信息。
  5. 如果来源是 PR 或差异内容，请描述此次变更试图解决的问题，而不是它修改了哪些文件或代码。
  6. 除非无法确定问题和期望行为，否则立即起草问题描述。如果无法确定，请提出一个简短的澄清问题。

每个问题只对应一个问题点。如果来源将互不相关的问题打包在一起，请为最重要的问题起草描述，逐条列出其他问题，并告知贡献者应将它们拆分为独立的问题和独立的拉取请求。

如果来源是在增加功能，而不是修复错误行为，不要把缺少该功能说成 Bug。请描述用户目前无法做什么，以及该功能的完整用户体验：谁会使用、从哪里使用，以及会看到什么。

不要臆造来源没有支持的用户影响、复现步骤或确定性。如果来源只展示了清理、重构或可能的代码异味，请说明目前无法明确具体问题，而不要凭空编造问题——这条规则优先于第 6 步。请用两到三句话说明来源展示了什么，以及需要哪些证据才能使其成为值得报告的问题。

如果来源修复的是尚未公开的安全弱点，不要起草公开的问题来描述它。请建议私下向维护者报告。

写作规则

  • 使用通俗的语言和简短的句子。
  • 问题描述应少于 200 个单词，除非显然需要更多内容来说明复现步骤或大型功能。
  • 先描述行为，不要先讲代码、架构或拟议的修复方案。如果不解释原因就无法理解症状，可以用一句通俗的话说明原因。
  • 只有在复现或理解问题时必不可少，才保留技术细节。能帮助解释症状的限制和默认值（批次大小、配额、上限）也属于必要细节。
  • 保留有用的证据，例如错误消息、截图、链接和文档引用。
  • 不要提及 AI 编写或审阅了问题描述。
  • 避免填充内容、赞美、路线图用语和穷举边缘情况。
  • 保持与贡献者一致的确定程度。不要把猜测说成已确认的 Bug；如果来源描述的是风险而非已观察到的故障，请使用“可能”或“似乎”等措辞。

输出格式

第一行是问题标题——在 GitHub 上提交时，请将其填写在标题栏中，而不要在正文中重复。对于缺少的功能，标题应描述预期结果（“标记没有结构化数据的页面”），而不是伪装成 Bug（“审计从不提及结构化数据”）。

如果没有有用内容可补充，请省略 额外背景 部分。限制条件和范围说明应放在该部分，包括维护者可能会合理担心但实际不受影响的情况。

# <Short title describing the problem or desired outcome>

## TL;DR

<In one or two sentences, explain what happens now and what should happen instead.>

## What is happening?

<Describe the current behavior in plain language. Include a concrete example when available.>

## What should happen?

<Describe the desired behavior without proposing how to build it.>

## Extra context

<Optional reproduction steps, error text, screenshots, links, or constraints.>

示例

# The chat jumps away from messages I am reading

## TL;DR

When I scroll up to read an older message, a new response moves me back to the bottom of the chat. The chat should stay where I left it until I choose to return to the latest message.

## What is happening?

New responses automatically scroll the chat to the bottom, even when I am reading earlier messages.

## What should happen?

Keep my current scroll position and show that a new message is available.

评论

支持 Markdown