design

Analyze GitHub issue requirements and draft an implementation design.

3|Updated Nov 5, 2023
One-click install
npx skills add https://github.com/Junroot/Nomat --skill design-junroot
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: design
Source: https://github.com/Junroot/Nomat/tree/main/.claude/skills/design
Command: npx skills add https://github.com/Junroot/Nomat --skill design-junroot

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

이슈의 요구사항을 읽고 그에 맞춘 구현 설계를 자동으로 산출하여 코드베이스를 효과적으로 개선하는 데 도움을 준다. 설계 결과는 이슈 코멘트로 남기고, 설계 라벨을 추가한다.

Core Features & Use Cases

  • 핵심 요구사항 추출: 이슈 본문에서 기능 및 수락 기준을 도출한다.
  • 코드베이스 분석: 헥사고날 아키텍처의 인바운드/아웃바운드 어댑터, 도메인, 서비스 계층 등을 탐색하여 설계에 반영한다.
  • 설계 산출물 생성: 구현 방법과 영향 범위를 담은 설계 코멘트를 이슈에 남기고, 관련 라벨을 관리한다.
  • 사용 사례: 예를 들어 이슈가 데이터 흐름 변경을 요구하면, 설계에서 영향 분석과 변경 범위를 명시한다.

Quick Start

이슈 번호를 지정하거나 요구사항/검증 라벨이 달린 이슈 목록에서 하나를 선택해 설계 초안 생성을 시작한다.

Frequently Asked Questions about design

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate an implementation design from a GitHub issue?

To generate an implementation design from a GitHub issue, the tool reads the issue body, extracts functional requirements and acceptance criteria, and maps them to hexagonal architecture components to produce a concrete design document.

Can I automatically analyze my codebase for architectural impact when requirements change?

Yes, you can analyze your codebase for architectural impact by exploring hexagonal architecture layers like inbound and outbound adapters, domains, and service layers to reflect necessary changes in the design plan.

How does issue triage work with requirement and verified labels?

Issue triage applies to open issues labeled with requirement and verified. When these labels are absent, the system prompts you to select from a list of eligible issues to begin drafting the design.

What is the best way to map GitHub requirements to hexagonal architecture components?

The best way to map GitHub requirements to hexagonal architecture components is by reading the issue body, identifying core data flow changes, and matching them to the appropriate domain and adapter layers in the codebase.

Do I need specific labels on my GitHub issues to start architecture analysis?

You need requirement and verified labels on your GitHub issues for automatic architecture analysis. If issues lack these labels, you will be prompted to manually select an eligible issue to proceed.

What happens to the design plan after analyzing the issue requirements?

After analyzing issue requirements, the generated design plan detailing the implementation method and impact scope is posted as a comment on the GitHub issue, and a design label is added.