design

Analyze GitHub issue requirements and draft an implementation design.

3|Updated Nov 5, 2023
Ready to run
npx skills add https://github.com/Junroot/Nomat --skill design-junroot
๐Ÿ’ฌ Prompt for ChatGPT / Claude Chatโ–ผ
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.