Skip to content

docs(sdd): narrow issue sync scope#1905

Merged
zerob13 merged 1 commit into
devfrom
codex/sdd-issue-sync-scope
Jul 9, 2026
Merged

docs(sdd): narrow issue sync scope#1905
zerob13 merged 1 commit into
devfrom
codex/sdd-issue-sync-scope

Conversation

@zerob13

@zerob13 zerob13 commented Jul 9, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • narrow SDD usage to substantial DeepChat changes
  • make GitHub issue sync opt-in or post-work approval only
  • align AGENTS.md, spec-driven-dev docs, and the deepchat-sdd skill

Validation

  • corepack pnpm run format
  • corepack pnpm run i18n
  • corepack pnpm run lint

Summary by CodeRabbit

  • Documentation

    • Clarified when to use the spec-driven workflow versus skipping it for small, localized changes.
    • Updated guidance for handling complex bug work, issue tracking, and PR links.
  • Chores

    • Revised contributor and agent instructions to align on when GitHub issue syncing should happen and what information must be recorded.

@coderabbitai

coderabbitai Bot commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: fe7ee09f-59a0-4e7b-b2ba-695d2a0912c7

📥 Commits

Reviewing files that changed from the base of the PR and between ccc1f0b and 928828d.

📒 Files selected for processing (4)
  • .agents/skills/deepchat-sdd/SKILL.md
  • .agents/skills/deepchat-sdd/agents/openai.yaml
  • AGENTS.md
  • docs/spec-driven-dev.md

📝 Walkthrough

Walkthrough

This PR revises Specification-Driven Development (SDD) policy across .agents/skills/deepchat-sdd/SKILL.md, its openai.yaml agent config, AGENTS.md, and docs/spec-driven-dev.md. Changes tighten goal classification rules and shift GitHub issue sync from default behavior to explicit-request/approval-only, with updated eligibility, labeling, and workflow sequencing.

Changes

SDD Policy Update

Layer / File(s) Summary
Skill classification and artifact rules
.agents/skills/deepchat-sdd/SKILL.md
Rewrites description, "When To Use," and "Classify The Goal" sections with clearer durable-spec criteria and bug reclassification rules; replaces small-bug/GitHub sync policy with new eligibility, labeling, and [NEEDS CLARIFICATION] resolution rules; adjusts later workflow steps to ask about sync only after scope clarification and to run format/i18n/lint only when relevant files changed.
Agent config alignment
.agents/skills/deepchat-sdd/agents/openai.yaml
Narrows short_description and default_prompt to substantial changes only, skipping trivial fixes and asking before GitHub issue sync.
Contributor guidelines update
AGENTS.md
Adjusts PR checklist wording to link issues only when available; replaces SDD section with folder-per-goal structure and sync eligibility rules requiring Closes #NNN``.
Spec-driven-dev doc rewrite
docs/spec-driven-dev.md
Adds guidance on when to use/skip SDD; renames "small bug goals" to "complex bug goals"; expands GitHub Issue Sync section; updates checklist and Definition of Done to require issue linkage or sync decision and Closes #NNN`` references.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related PRs

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title is concise and accurately reflects a key change: narrowing when GitHub issue sync applies.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex/sdd-issue-sync-scope

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@zerob13 zerob13 merged commit a45823f into dev Jul 9, 2026
3 checks passed
@zhangmo8 zhangmo8 deleted the codex/sdd-issue-sync-scope branch July 9, 2026 08:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant