qualia-framework 2.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +50 -0
- package/bin/cli.js +519 -0
- package/framework/agents/architecture-strategist.md +53 -0
- package/framework/agents/backend-agent.md +150 -0
- package/framework/agents/code-simplicity-reviewer.md +86 -0
- package/framework/agents/frontend-agent.md +111 -0
- package/framework/agents/kieran-typescript-reviewer.md +96 -0
- package/framework/agents/performance-oracle.md +111 -0
- package/framework/agents/qualia-codebase-mapper.md +760 -0
- package/framework/agents/qualia-debugger.md +1203 -0
- package/framework/agents/qualia-executor.md +881 -0
- package/framework/agents/qualia-integration-checker.md +423 -0
- package/framework/agents/qualia-phase-researcher.md +453 -0
- package/framework/agents/qualia-plan-checker.md +699 -0
- package/framework/agents/qualia-planner.md +1241 -0
- package/framework/agents/qualia-project-researcher.md +602 -0
- package/framework/agents/qualia-research-synthesizer.md +236 -0
- package/framework/agents/qualia-roadmapper.md +605 -0
- package/framework/agents/qualia-verifier.md +685 -0
- package/framework/agents/team-orchestrator.md +228 -0
- package/framework/agents/teams/full-stack-team.md +48 -0
- package/framework/agents/teams/optimize-team.md +53 -0
- package/framework/agents/teams/review-team.md +62 -0
- package/framework/agents/teams/ship-team.md +86 -0
- package/framework/agents/test-agent.md +182 -0
- package/framework/askpass.sh +2 -0
- package/framework/commands/design.md +53 -0
- package/framework/commands/quick-db.md +22 -0
- package/framework/config/retention.json +35 -0
- package/framework/core/PRINCIPLES.md +77 -0
- package/framework/hooks/auto-format.sh +45 -0
- package/framework/hooks/block-env-edit.sh +42 -0
- package/framework/hooks/branch-guard.sh +46 -0
- package/framework/hooks/confirm-delete.sh +56 -0
- package/framework/hooks/migration-validate.sh +68 -0
- package/framework/hooks/notification-speak.sh +15 -0
- package/framework/hooks/pre-commit.sh +80 -0
- package/framework/hooks/pre-compact.sh +55 -0
- package/framework/hooks/pre-deploy-gate.sh +151 -0
- package/framework/hooks/qualia-colors.sh +32 -0
- package/framework/hooks/retention-cleanup.sh +43 -0
- package/framework/hooks/save-session-state.sh +153 -0
- package/framework/hooks/session-context-loader.sh +28 -0
- package/framework/hooks/session-learn.sh +30 -0
- package/framework/knowledge/claudecode-bible.md +1384 -0
- package/framework/knowledge/client-prefs.md +22 -0
- package/framework/knowledge/common-fixes.md +25 -0
- package/framework/knowledge/deployment-map.md +35 -0
- package/framework/knowledge/email-signature.html +1 -0
- package/framework/knowledge/employees.md +8 -0
- package/framework/knowledge/learned-patterns.md +51 -0
- package/framework/knowledge/optimization-research-2026.md +137 -0
- package/framework/knowledge/qualia-context.md +67 -0
- package/framework/knowledge/supabase-patterns.md +50 -0
- package/framework/knowledge/voice-agent-patterns.md +46 -0
- package/framework/qualia-engine/VERSION +1 -0
- package/framework/qualia-engine/bin/qualia-tools.js +2160 -0
- package/framework/qualia-engine/bin/qualia-tools.test.js +1054 -0
- package/framework/qualia-engine/references/checkpoints.md +775 -0
- package/framework/qualia-engine/references/continuation-format.md +249 -0
- package/framework/qualia-engine/references/decimal-phase-calculation.md +65 -0
- package/framework/qualia-engine/references/design-quality.md +56 -0
- package/framework/qualia-engine/references/git-integration.md +254 -0
- package/framework/qualia-engine/references/git-planning-commit.md +50 -0
- package/framework/qualia-engine/references/model-profile-resolution.md +32 -0
- package/framework/qualia-engine/references/model-profiles.md +73 -0
- package/framework/qualia-engine/references/phase-argument-parsing.md +61 -0
- package/framework/qualia-engine/references/planning-config.md +195 -0
- package/framework/qualia-engine/references/questioning.md +141 -0
- package/framework/qualia-engine/references/tdd.md +263 -0
- package/framework/qualia-engine/references/ui-brand.md +160 -0
- package/framework/qualia-engine/references/verification-patterns.md +612 -0
- package/framework/qualia-engine/templates/DEBUG.md +159 -0
- package/framework/qualia-engine/templates/DESIGN.md +81 -0
- package/framework/qualia-engine/templates/UAT.md +247 -0
- package/framework/qualia-engine/templates/codebase/architecture.md +255 -0
- package/framework/qualia-engine/templates/codebase/concerns.md +310 -0
- package/framework/qualia-engine/templates/codebase/conventions.md +307 -0
- package/framework/qualia-engine/templates/codebase/integrations.md +280 -0
- package/framework/qualia-engine/templates/codebase/stack.md +186 -0
- package/framework/qualia-engine/templates/codebase/structure.md +285 -0
- package/framework/qualia-engine/templates/codebase/testing.md +480 -0
- package/framework/qualia-engine/templates/config.json +35 -0
- package/framework/qualia-engine/templates/context.md +283 -0
- package/framework/qualia-engine/templates/continue-here.md +78 -0
- package/framework/qualia-engine/templates/debug-subagent-prompt.md +91 -0
- package/framework/qualia-engine/templates/discovery.md +146 -0
- package/framework/qualia-engine/templates/milestone-archive.md +123 -0
- package/framework/qualia-engine/templates/milestone.md +115 -0
- package/framework/qualia-engine/templates/phase-prompt.md +567 -0
- package/framework/qualia-engine/templates/planner-subagent-prompt.md +117 -0
- package/framework/qualia-engine/templates/project.md +184 -0
- package/framework/qualia-engine/templates/projects/ai-agent.md +156 -0
- package/framework/qualia-engine/templates/projects/mobile-app.md +181 -0
- package/framework/qualia-engine/templates/projects/voice-agent.md +134 -0
- package/framework/qualia-engine/templates/projects/website.md +137 -0
- package/framework/qualia-engine/templates/requirements.md +231 -0
- package/framework/qualia-engine/templates/research-project/ARCHITECTURE.md +204 -0
- package/framework/qualia-engine/templates/research-project/FEATURES.md +147 -0
- package/framework/qualia-engine/templates/research-project/PITFALLS.md +200 -0
- package/framework/qualia-engine/templates/research-project/STACK.md +120 -0
- package/framework/qualia-engine/templates/research-project/SUMMARY.md +170 -0
- package/framework/qualia-engine/templates/research.md +552 -0
- package/framework/qualia-engine/templates/roadmap.md +202 -0
- package/framework/qualia-engine/templates/state.md +176 -0
- package/framework/qualia-engine/templates/summary-complex.md +59 -0
- package/framework/qualia-engine/templates/summary-minimal.md +41 -0
- package/framework/qualia-engine/templates/summary-standard.md +48 -0
- package/framework/qualia-engine/templates/summary.md +246 -0
- package/framework/qualia-engine/templates/user-setup.md +311 -0
- package/framework/qualia-engine/templates/verification-report.md +322 -0
- package/framework/qualia-engine/workflows/add-phase.md +179 -0
- package/framework/qualia-engine/workflows/add-todo.md +157 -0
- package/framework/qualia-engine/workflows/audit-milestone.md +241 -0
- package/framework/qualia-engine/workflows/check-todos.md +176 -0
- package/framework/qualia-engine/workflows/complete-milestone.md +858 -0
- package/framework/qualia-engine/workflows/diagnose-issues.md +219 -0
- package/framework/qualia-engine/workflows/discovery-phase.md +289 -0
- package/framework/qualia-engine/workflows/discuss-phase.md +534 -0
- package/framework/qualia-engine/workflows/execute-phase.md +559 -0
- package/framework/qualia-engine/workflows/execute-plan.md +438 -0
- package/framework/qualia-engine/workflows/help.md +470 -0
- package/framework/qualia-engine/workflows/insert-phase.md +220 -0
- package/framework/qualia-engine/workflows/list-phase-assumptions.md +178 -0
- package/framework/qualia-engine/workflows/map-codebase.md +327 -0
- package/framework/qualia-engine/workflows/new-milestone.md +363 -0
- package/framework/qualia-engine/workflows/new-project.md +1037 -0
- package/framework/qualia-engine/workflows/pause-work.md +122 -0
- package/framework/qualia-engine/workflows/plan-milestone-gaps.md +256 -0
- package/framework/qualia-engine/workflows/plan-phase.md +422 -0
- package/framework/qualia-engine/workflows/progress.md +354 -0
- package/framework/qualia-engine/workflows/quick.md +252 -0
- package/framework/qualia-engine/workflows/remove-phase.md +326 -0
- package/framework/qualia-engine/workflows/research-phase.md +74 -0
- package/framework/qualia-engine/workflows/resume-project.md +306 -0
- package/framework/qualia-engine/workflows/set-profile.md +80 -0
- package/framework/qualia-engine/workflows/settings.md +145 -0
- package/framework/qualia-engine/workflows/transition.md +556 -0
- package/framework/qualia-engine/workflows/update.md +197 -0
- package/framework/qualia-engine/workflows/verify-phase.md +195 -0
- package/framework/qualia-engine/workflows/verify-work.md +625 -0
- package/framework/rules/context7.md +11 -0
- package/framework/rules/deployment.md +29 -0
- package/framework/rules/frontend.md +33 -0
- package/framework/rules/security.md +12 -0
- package/framework/rules/speed.md +20 -0
- package/framework/scripts/__pycache__/say.cpython-314.pyc +0 -0
- package/framework/scripts/apply-retention.sh +120 -0
- package/framework/scripts/bootstrap-pop-os.sh +354 -0
- package/framework/scripts/claude-voice +13 -0
- package/framework/scripts/cleanup.sh +131 -0
- package/framework/scripts/cowork-mode.sh +141 -0
- package/framework/scripts/generate-project-claude-md.sh +153 -0
- package/framework/scripts/load-test-webhook.js +172 -0
- package/framework/scripts/say.py +236 -0
- package/framework/scripts/showcase-video-recorder/ffmpeg-builder.js +167 -0
- package/framework/scripts/showcase-video-recorder/playwright-helpers.js +216 -0
- package/framework/scripts/speak.py +55 -0
- package/framework/scripts/speak.sh +18 -0
- package/framework/scripts/status.sh +138 -0
- package/framework/scripts/sync-to-framework.sh +65 -0
- package/framework/scripts/voice-hotkey.py +227 -0
- package/framework/scripts/voice-input.sh +51 -0
- package/framework/skills/animate/SKILL.md +202 -0
- package/framework/skills/bolder/SKILL.md +144 -0
- package/framework/skills/browser-qa/SKILL.md +536 -0
- package/framework/skills/clarify/SKILL.md +179 -0
- package/framework/skills/colorize/SKILL.md +170 -0
- package/framework/skills/critique/SKILL.md +126 -0
- package/framework/skills/deep-research/SKILL.md +271 -0
- package/framework/skills/delight/SKILL.md +329 -0
- package/framework/skills/deploy/SKILL.md +261 -0
- package/framework/skills/deploy-verify/SKILL.md +377 -0
- package/framework/skills/deploy-verify/scripts/canary-check.sh +206 -0
- package/framework/skills/deploy-verify/scripts/check-console-errors.js +147 -0
- package/framework/skills/deploy-verify/scripts/check-cwv.js +139 -0
- package/framework/skills/deploy-verify/scripts/project-detect.sh +84 -0
- package/framework/skills/deploy-verify/scripts/verify.sh +548 -0
- package/framework/skills/design-quieter/SKILL.md +130 -0
- package/framework/skills/distill/SKILL.md +149 -0
- package/framework/skills/docs-lookup/SKILL.md +78 -0
- package/framework/skills/fcm-notifications/SKILL.md +125 -0
- package/framework/skills/financial-ledger/SKILL.md +1039 -0
- package/framework/skills/frontend-master/NOTICE.md +4 -0
- package/framework/skills/frontend-master/SKILL.md +127 -0
- package/framework/skills/frontend-master/reference/color-and-contrast.md +132 -0
- package/framework/skills/frontend-master/reference/interaction-design.md +123 -0
- package/framework/skills/frontend-master/reference/motion-design.md +99 -0
- package/framework/skills/frontend-master/reference/responsive-design.md +114 -0
- package/framework/skills/frontend-master/reference/spatial-design.md +100 -0
- package/framework/skills/frontend-master/reference/typography.md +131 -0
- package/framework/skills/frontend-master/reference/ux-writing.md +107 -0
- package/framework/skills/harden/SKILL.md +357 -0
- package/framework/skills/i18n-rtl/SKILL.md +752 -0
- package/framework/skills/learn/SKILL.md +71 -0
- package/framework/skills/memory/SKILL.md +50 -0
- package/framework/skills/mobile-expo/SKILL.md +864 -0
- package/framework/skills/mobile-expo/references/store-checklist.md +550 -0
- package/framework/skills/nestjs-backend/README.md +73 -0
- package/framework/skills/nestjs-backend/SKILL.md +446 -0
- package/framework/skills/nestjs-backend/references/templates.md +1173 -0
- package/framework/skills/normalize/SKILL.md +79 -0
- package/framework/skills/onboard/SKILL.md +242 -0
- package/framework/skills/polish/SKILL.md +209 -0
- package/framework/skills/pr/SKILL.md +66 -0
- package/framework/skills/qualia/SKILL.md +153 -0
- package/framework/skills/qualia-add-todo/SKILL.md +68 -0
- package/framework/skills/qualia-audit-milestone/SKILL.md +92 -0
- package/framework/skills/qualia-check-todos/SKILL.md +55 -0
- package/framework/skills/qualia-complete-milestone/SKILL.md +108 -0
- package/framework/skills/qualia-debug/SKILL.md +149 -0
- package/framework/skills/qualia-design/SKILL.md +203 -0
- package/framework/skills/qualia-discuss-phase/SKILL.md +72 -0
- package/framework/skills/qualia-execute-phase/SKILL.md +86 -0
- package/framework/skills/qualia-help/SKILL.md +67 -0
- package/framework/skills/qualia-idk/SKILL.md +352 -0
- package/framework/skills/qualia-list-phase-assumptions/SKILL.md +67 -0
- package/framework/skills/qualia-new-milestone/SKILL.md +72 -0
- package/framework/skills/qualia-new-project/SKILL.md +92 -0
- package/framework/skills/qualia-optimize/SKILL.md +417 -0
- package/framework/skills/qualia-pause-work/SKILL.md +96 -0
- package/framework/skills/qualia-plan-milestone-gaps/SKILL.md +57 -0
- package/framework/skills/qualia-plan-phase/SKILL.md +101 -0
- package/framework/skills/qualia-progress/SKILL.md +53 -0
- package/framework/skills/qualia-quick/SKILL.md +89 -0
- package/framework/skills/qualia-research-phase/SKILL.md +88 -0
- package/framework/skills/qualia-resume-work/SKILL.md +62 -0
- package/framework/skills/qualia-review/SKILL.md +263 -0
- package/framework/skills/qualia-start/SKILL.md +182 -0
- package/framework/skills/qualia-verify-work/SKILL.md +105 -0
- package/framework/skills/qualia-workflow/SKILL.md +130 -0
- package/framework/skills/rag/SKILL.md +750 -0
- package/framework/skills/responsive/SKILL.md +231 -0
- package/framework/skills/retro/SKILL.md +284 -0
- package/framework/skills/sakani-conventions/SKILL.md +136 -0
- package/framework/skills/sakani-conventions/evals/evals.json +23 -0
- package/framework/skills/sakani-conventions/references/entities.md +365 -0
- package/framework/skills/sakani-conventions/references/error-codes.md +95 -0
- package/framework/skills/seo-master/SKILL.md +490 -0
- package/framework/skills/seo-master/references/checklist.md +199 -0
- package/framework/skills/seo-master/references/structured-data.md +609 -0
- package/framework/skills/ship/SKILL.md +202 -0
- package/framework/skills/stack-researcher/SKILL.md +215 -0
- package/framework/skills/status/SKILL.md +154 -0
- package/framework/skills/status/scripts/health-check.sh +562 -0
- package/framework/skills/subscription-payments/SKILL.md +250 -0
- package/framework/skills/supabase/SKILL.md +973 -0
- package/framework/skills/supabase/references/templates.md +159 -0
- package/framework/skills/team/SKILL.md +67 -0
- package/framework/skills/test-runner/SKILL.md +202 -0
- package/framework/skills/voice-agent/SKILL.md +407 -0
- package/framework/skills/zoho-workflow/SKILL.md +51 -0
- package/framework/statusline-command.sh +117 -0
- package/package.json +24 -0
- package/profiles/fawzi.json +16 -0
- package/profiles/hasan.json +16 -0
- package/profiles/moayad.json +16 -0
- package/templates/CLAUDE-owner.md +52 -0
- package/templates/CLAUDE.md.hbs +58 -0
- package/templates/env.claude.template +12 -0
- package/templates/settings.json +141 -0
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: normalize
|
|
3
|
+
description: Normalize design to match your design system and ensure consistency
|
|
4
|
+
user-invokable: true
|
|
5
|
+
args:
|
|
6
|
+
- name: feature
|
|
7
|
+
description: The page, route, or feature to normalize (optional)
|
|
8
|
+
required: false
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
Analyze and redesign the feature to perfectly match our design system standards, aesthetics, and established patterns.
|
|
12
|
+
|
|
13
|
+
## Read DESIGN.md (Authoritative Source)
|
|
14
|
+
|
|
15
|
+
Before searching for design system documentation, check for the project's DESIGN.md:
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
cat .planning/DESIGN.md 2>/dev/null
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
**If DESIGN.md exists:** This IS the design system for this project. Use it as the primary reference for tokens, patterns, and constraints. Still search for additional design system docs (component libraries, style guides), but DESIGN.md decisions take precedence.
|
|
22
|
+
|
|
23
|
+
**If DESIGN.md does not exist:** Proceed with the design system discovery step below.
|
|
24
|
+
|
|
25
|
+
## Plan
|
|
26
|
+
|
|
27
|
+
Before making changes, deeply understand the context:
|
|
28
|
+
|
|
29
|
+
1. **Discover the design system**: Search for design system documentation, UI guidelines, component libraries, or style guides (grep for "design system", "ui guide", "style guide", etc.). Study it thoroughly until you understand:
|
|
30
|
+
- Core design principles and aesthetic direction
|
|
31
|
+
- Target audience and personas
|
|
32
|
+
- Component patterns and conventions
|
|
33
|
+
- Design tokens (colors, typography, spacing)
|
|
34
|
+
|
|
35
|
+
**CRITICAL**: If something isn't clear, ask. Don't guess at design system principles.
|
|
36
|
+
|
|
37
|
+
2. **Analyze the current feature**: Assess what works and what doesn't:
|
|
38
|
+
- Where does it deviate from design system patterns?
|
|
39
|
+
- Which inconsistencies are cosmetic vs. functional?
|
|
40
|
+
- What's the root cause—missing tokens, one-off implementations, or conceptual misalignment?
|
|
41
|
+
|
|
42
|
+
3. **Create a normalization plan**: Define specific changes that will align the feature with the design system:
|
|
43
|
+
- Which components can be replaced with design system equivalents?
|
|
44
|
+
- Which styles need to use design tokens instead of hard-coded values?
|
|
45
|
+
- How can UX patterns match established user flows?
|
|
46
|
+
|
|
47
|
+
**IMPORTANT**: Great design is effective design. Prioritize UX consistency and usability over visual polish alone. Think through the best possible experience for your use case and personas first.
|
|
48
|
+
|
|
49
|
+
## Execute
|
|
50
|
+
|
|
51
|
+
Systematically address all inconsistencies across these dimensions:
|
|
52
|
+
|
|
53
|
+
- **Typography**: Use design system fonts, sizes, weights, and line heights. Replace hard-coded values with typographic tokens or classes.
|
|
54
|
+
- **Color & Theme**: Apply design system color tokens. Remove one-off color choices that break the palette.
|
|
55
|
+
- **Spacing & Layout**: Use spacing tokens (margins, padding, gaps). Align with grid systems and layout patterns used elsewhere.
|
|
56
|
+
- **Components**: Replace custom implementations with design system components. Ensure props and variants match established patterns.
|
|
57
|
+
- **Motion & Interaction**: Match animation timing, easing, and interaction patterns to other features.
|
|
58
|
+
- **Responsive Behavior**: Ensure breakpoints and responsive patterns align with design system standards.
|
|
59
|
+
- **Accessibility**: Verify contrast ratios, focus states, ARIA labels match design system requirements.
|
|
60
|
+
- **Progressive Disclosure**: Match information hierarchy and complexity management to established patterns.
|
|
61
|
+
|
|
62
|
+
**NEVER**:
|
|
63
|
+
- Create new one-off components when design system equivalents exist
|
|
64
|
+
- Hard-code values that should use design tokens
|
|
65
|
+
- Introduce new patterns that diverge from the design system
|
|
66
|
+
- Compromise accessibility for visual consistency
|
|
67
|
+
|
|
68
|
+
This is not an exhaustive list—apply judgment to identify all areas needing normalization.
|
|
69
|
+
|
|
70
|
+
## Clean Up
|
|
71
|
+
|
|
72
|
+
After normalization, ensure code quality:
|
|
73
|
+
|
|
74
|
+
- **Consolidate reusable components**: If you created new components that should be shared, move them to the design system or shared UI component path.
|
|
75
|
+
- **Remove orphaned code**: Delete unused implementations, styles, or files made obsolete by normalization.
|
|
76
|
+
- **Verify quality**: Lint, type-check, and test according to repository guidelines. Ensure normalization didn't introduce regressions.
|
|
77
|
+
- **Ensure DRYness**: Look for duplication introduced during refactoring and consolidate.
|
|
78
|
+
|
|
79
|
+
Remember: You are a brilliant frontend designer with impeccable taste, equally strong in UX and UI. Your attention to detail and eye for end-to-end user experience is world class. Execute with precision and thoroughness.
|
|
@@ -0,0 +1,242 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: onboard
|
|
3
|
+
description: Design or improve onboarding flows, empty states, and first-time user experiences. Helps users get started successfully and understand value quickly.
|
|
4
|
+
user-invokable: true
|
|
5
|
+
args:
|
|
6
|
+
- name: target
|
|
7
|
+
description: The feature or area needing onboarding (optional)
|
|
8
|
+
required: false
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
Create or improve onboarding experiences that help users understand, adopt, and succeed with the product quickly.
|
|
12
|
+
|
|
13
|
+
## Assess Onboarding Needs
|
|
14
|
+
|
|
15
|
+
Understand what users need to learn and why:
|
|
16
|
+
|
|
17
|
+
1. **Identify the challenge**:
|
|
18
|
+
- What are users trying to accomplish?
|
|
19
|
+
- What's confusing or unclear about current experience?
|
|
20
|
+
- Where do users get stuck or drop off?
|
|
21
|
+
- What's the "aha moment" we want users to reach?
|
|
22
|
+
|
|
23
|
+
2. **Understand the users**:
|
|
24
|
+
- What's their experience level? (Beginners, power users, mixed?)
|
|
25
|
+
- What's their motivation? (Excited and exploring? Required by work?)
|
|
26
|
+
- What's their time commitment? (5 minutes? 30 minutes?)
|
|
27
|
+
- What alternatives do they know? (Coming from competitor? New to category?)
|
|
28
|
+
|
|
29
|
+
3. **Define success**:
|
|
30
|
+
- What's the minimum users need to learn to be successful?
|
|
31
|
+
- What's the key action we want them to take? (First project? First invite?)
|
|
32
|
+
- How do we know onboarding worked? (Completion rate? Time to value?)
|
|
33
|
+
|
|
34
|
+
**CRITICAL**: Onboarding should get users to value as quickly as possible, not teach everything possible.
|
|
35
|
+
|
|
36
|
+
## Onboarding Principles
|
|
37
|
+
|
|
38
|
+
Follow these core principles:
|
|
39
|
+
|
|
40
|
+
### Show, Don't Tell
|
|
41
|
+
- Demonstrate with working examples, not just descriptions
|
|
42
|
+
- Provide real functionality in onboarding, not separate tutorial mode
|
|
43
|
+
- Use progressive disclosure - teach one thing at a time
|
|
44
|
+
|
|
45
|
+
### Make It Optional (When Possible)
|
|
46
|
+
- Let experienced users skip onboarding
|
|
47
|
+
- Don't block access to product
|
|
48
|
+
- Provide "Skip" or "I'll explore on my own" options
|
|
49
|
+
|
|
50
|
+
### Time to Value
|
|
51
|
+
- Get users to their "aha moment" ASAP
|
|
52
|
+
- Front-load most important concepts
|
|
53
|
+
- Teach 20% that delivers 80% of value
|
|
54
|
+
- Save advanced features for contextual discovery
|
|
55
|
+
|
|
56
|
+
### Context Over Ceremony
|
|
57
|
+
- Teach features when users need them, not upfront
|
|
58
|
+
- Empty states are onboarding opportunities
|
|
59
|
+
- Tooltips and hints at point of use
|
|
60
|
+
|
|
61
|
+
### Respect User Intelligence
|
|
62
|
+
- Don't patronize or over-explain
|
|
63
|
+
- Be concise and clear
|
|
64
|
+
- Assume users can figure out standard patterns
|
|
65
|
+
|
|
66
|
+
## Design Onboarding Experiences
|
|
67
|
+
|
|
68
|
+
Create appropriate onboarding for the context:
|
|
69
|
+
|
|
70
|
+
### Initial Product Onboarding
|
|
71
|
+
|
|
72
|
+
**Welcome Screen**:
|
|
73
|
+
- Clear value proposition (what is this product?)
|
|
74
|
+
- What users will learn/accomplish
|
|
75
|
+
- Time estimate (honest about commitment)
|
|
76
|
+
- Option to skip (for experienced users)
|
|
77
|
+
|
|
78
|
+
**Account Setup**:
|
|
79
|
+
- Minimal required information (collect more later)
|
|
80
|
+
- Explain why you're asking for each piece of information
|
|
81
|
+
- Smart defaults where possible
|
|
82
|
+
- Social login when appropriate
|
|
83
|
+
|
|
84
|
+
**Core Concept Introduction**:
|
|
85
|
+
- Introduce 1-3 core concepts (not everything)
|
|
86
|
+
- Use simple language and examples
|
|
87
|
+
- Interactive when possible (do, don't just read)
|
|
88
|
+
- Progress indication (step 1 of 3)
|
|
89
|
+
|
|
90
|
+
**First Success**:
|
|
91
|
+
- Guide users to accomplish something real
|
|
92
|
+
- Pre-populated examples or templates
|
|
93
|
+
- Celebrate completion (but don't overdo it)
|
|
94
|
+
- Clear next steps
|
|
95
|
+
|
|
96
|
+
### Feature Discovery & Adoption
|
|
97
|
+
|
|
98
|
+
**Empty States**:
|
|
99
|
+
Instead of blank space, show:
|
|
100
|
+
- What will appear here (description + screenshot/illustration)
|
|
101
|
+
- Why it's valuable
|
|
102
|
+
- Clear CTA to create first item
|
|
103
|
+
- Example or template option
|
|
104
|
+
|
|
105
|
+
Example:
|
|
106
|
+
```
|
|
107
|
+
No projects yet
|
|
108
|
+
Projects help you organize your work and collaborate with your team.
|
|
109
|
+
[Create your first project] or [Start from template]
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
**Contextual Tooltips**:
|
|
113
|
+
- Appear at relevant moment (first time user sees feature)
|
|
114
|
+
- Point directly at relevant UI element
|
|
115
|
+
- Brief explanation + benefit
|
|
116
|
+
- Dismissable (with "Don't show again" option)
|
|
117
|
+
- Optional "Learn more" link
|
|
118
|
+
|
|
119
|
+
**Feature Announcements**:
|
|
120
|
+
- Highlight new features when they're released
|
|
121
|
+
- Show what's new and why it matters
|
|
122
|
+
- Let users try immediately
|
|
123
|
+
- Dismissable
|
|
124
|
+
|
|
125
|
+
**Progressive Onboarding**:
|
|
126
|
+
- Teach features when users encounter them
|
|
127
|
+
- Badges or indicators on new/unused features
|
|
128
|
+
- Unlock complexity gradually (don't show all options immediately)
|
|
129
|
+
|
|
130
|
+
### Guided Tours & Walkthroughs
|
|
131
|
+
|
|
132
|
+
**When to use**:
|
|
133
|
+
- Complex interfaces with many features
|
|
134
|
+
- Significant changes to existing product
|
|
135
|
+
- Industry-specific tools needing domain knowledge
|
|
136
|
+
|
|
137
|
+
**How to design**:
|
|
138
|
+
- Spotlight specific UI elements (dim rest of page)
|
|
139
|
+
- Keep steps short (3-7 steps max per tour)
|
|
140
|
+
- Allow users to click through tour freely
|
|
141
|
+
- Include "Skip tour" option
|
|
142
|
+
- Make replayable (help menu)
|
|
143
|
+
|
|
144
|
+
**Best practices**:
|
|
145
|
+
- Interactive > passive (let users click real buttons)
|
|
146
|
+
- Focus on workflow, not features ("Create a project" not "This is the project button")
|
|
147
|
+
- Provide sample data so actions work
|
|
148
|
+
|
|
149
|
+
### Interactive Tutorials
|
|
150
|
+
|
|
151
|
+
**When to use**:
|
|
152
|
+
- Users need hands-on practice
|
|
153
|
+
- Concepts are complex or unfamiliar
|
|
154
|
+
- High stakes (better to practice in safe environment)
|
|
155
|
+
|
|
156
|
+
**How to design**:
|
|
157
|
+
- Sandbox environment with sample data
|
|
158
|
+
- Clear objectives ("Create a chart showing sales by region")
|
|
159
|
+
- Step-by-step guidance
|
|
160
|
+
- Validation (confirm they did it right)
|
|
161
|
+
- Graduation moment (you're ready!)
|
|
162
|
+
|
|
163
|
+
### Documentation & Help
|
|
164
|
+
|
|
165
|
+
**In-product help**:
|
|
166
|
+
- Contextual help links throughout interface
|
|
167
|
+
- Keyboard shortcut reference
|
|
168
|
+
- Search-able help center
|
|
169
|
+
- Video tutorials for complex workflows
|
|
170
|
+
|
|
171
|
+
**Help patterns**:
|
|
172
|
+
- `?` icon near complex features
|
|
173
|
+
- "Learn more" links in tooltips
|
|
174
|
+
- Keyboard shortcut hints (`⌘K` shown on search box)
|
|
175
|
+
|
|
176
|
+
## Empty State Design
|
|
177
|
+
|
|
178
|
+
Every empty state needs:
|
|
179
|
+
|
|
180
|
+
### What Will Be Here
|
|
181
|
+
"Your recent projects will appear here"
|
|
182
|
+
|
|
183
|
+
### Why It Matters
|
|
184
|
+
"Projects help you organize your work and collaborate with your team"
|
|
185
|
+
|
|
186
|
+
### How to Get Started
|
|
187
|
+
[Create project] or [Import from template]
|
|
188
|
+
|
|
189
|
+
### Visual Interest
|
|
190
|
+
Illustration or icon (not just text on blank page)
|
|
191
|
+
|
|
192
|
+
### Contextual Help
|
|
193
|
+
"Need help getting started? [Watch 2-min tutorial]"
|
|
194
|
+
|
|
195
|
+
**Empty state types**:
|
|
196
|
+
- **First use**: Never used this feature (emphasize value, provide template)
|
|
197
|
+
- **User cleared**: Intentionally deleted everything (light touch, easy to recreate)
|
|
198
|
+
- **No results**: Search or filter returned nothing (suggest different query, clear filters)
|
|
199
|
+
- **No permissions**: Can't access (explain why, how to get access)
|
|
200
|
+
- **Error state**: Failed to load (explain what happened, retry option)
|
|
201
|
+
|
|
202
|
+
## Implementation Patterns
|
|
203
|
+
|
|
204
|
+
### Technical approaches:
|
|
205
|
+
|
|
206
|
+
**Tooltip libraries**: Tippy.js, Popper.js
|
|
207
|
+
**Tour libraries**: Intro.js, Shepherd.js, React Joyride
|
|
208
|
+
**Modal patterns**: Focus trap, backdrop, ESC to close
|
|
209
|
+
**Progress tracking**: LocalStorage for "seen" states
|
|
210
|
+
**Analytics**: Track completion, drop-off points
|
|
211
|
+
|
|
212
|
+
**Storage patterns**:
|
|
213
|
+
```javascript
|
|
214
|
+
// Track which onboarding steps user has seen
|
|
215
|
+
localStorage.setItem('onboarding-completed', 'true');
|
|
216
|
+
localStorage.setItem('feature-tooltip-seen-reports', 'true');
|
|
217
|
+
```
|
|
218
|
+
|
|
219
|
+
**IMPORTANT**: Don't show same onboarding twice (annoying). Track completion and respect dismissals.
|
|
220
|
+
|
|
221
|
+
**NEVER**:
|
|
222
|
+
- Force users through long onboarding before they can use product
|
|
223
|
+
- Patronize users with obvious explanations
|
|
224
|
+
- Show same tooltip repeatedly (respect dismissals)
|
|
225
|
+
- Block all UI during tour (let users explore)
|
|
226
|
+
- Create separate tutorial mode disconnected from real product
|
|
227
|
+
- Overwhelm with information upfront (progressive disclosure!)
|
|
228
|
+
- Hide "Skip" or make it hard to find
|
|
229
|
+
- Forget about returning users (don't show initial onboarding again)
|
|
230
|
+
|
|
231
|
+
## Verify Onboarding Quality
|
|
232
|
+
|
|
233
|
+
Test with real users:
|
|
234
|
+
|
|
235
|
+
- **Time to completion**: Can users complete onboarding quickly?
|
|
236
|
+
- **Comprehension**: Do users understand after completing?
|
|
237
|
+
- **Action**: Do users take desired next step?
|
|
238
|
+
- **Skip rate**: Are too many users skipping? (Maybe it's too long/not valuable)
|
|
239
|
+
- **Completion rate**: Are users completing? (If low, simplify)
|
|
240
|
+
- **Time to value**: How long until users get first value?
|
|
241
|
+
|
|
242
|
+
Remember: You're a product educator with excellent teaching instincts. Get users to their "aha moment" as quickly as possible. Teach the essential, make it contextual, respect user time and intelligence.
|
|
@@ -0,0 +1,209 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: polish
|
|
3
|
+
description: Final quality pass before shipping. Fixes alignment, spacing, consistency, and detail issues that separate good from great.
|
|
4
|
+
user-invokable: true
|
|
5
|
+
args:
|
|
6
|
+
- name: target
|
|
7
|
+
description: The feature or area to polish (optional)
|
|
8
|
+
required: false
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
**First**: Use the frontend-master skill for design principles and anti-patterns.
|
|
12
|
+
|
|
13
|
+
**Then**: Read the project's design decisions:
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
cat .planning/DESIGN.md 2>/dev/null
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
If DESIGN.md exists, use it as the authoritative source for this project's design tokens, spacing, and typography. Verify consistency against DESIGN.md decisions during polish (e.g., "DESIGN.md specifies 8px grid — this 13px gap violates the system"). If DESIGN.md does not exist, proceed with general design principles from frontend-master.
|
|
20
|
+
|
|
21
|
+
Perform a meticulous final pass to catch all the small details that separate good work from great work. The difference between shipped and polished.
|
|
22
|
+
|
|
23
|
+
## Pre-Polish Assessment
|
|
24
|
+
|
|
25
|
+
Understand the current state and goals:
|
|
26
|
+
|
|
27
|
+
1. **Review completeness**:
|
|
28
|
+
- Is it functionally complete?
|
|
29
|
+
- Are there known issues to preserve (mark with TODOs)?
|
|
30
|
+
- What's the quality bar? (MVP vs flagship feature?)
|
|
31
|
+
- When does it ship? (How much time for polish?)
|
|
32
|
+
|
|
33
|
+
2. **Identify polish areas**:
|
|
34
|
+
- Visual inconsistencies
|
|
35
|
+
- Spacing and alignment issues
|
|
36
|
+
- Interaction state gaps
|
|
37
|
+
- Copy inconsistencies
|
|
38
|
+
- Edge cases and error states
|
|
39
|
+
- Loading and transition smoothness
|
|
40
|
+
|
|
41
|
+
**CRITICAL**: Polish is the last step, not the first. Don't polish work that's not functionally complete.
|
|
42
|
+
|
|
43
|
+
## Polish Systematically
|
|
44
|
+
|
|
45
|
+
Work through these dimensions methodically:
|
|
46
|
+
|
|
47
|
+
### Visual Alignment & Spacing
|
|
48
|
+
|
|
49
|
+
- **Pixel-perfect alignment**: Everything lines up to grid
|
|
50
|
+
- **Consistent spacing**: All gaps use spacing scale (no random 13px gaps)
|
|
51
|
+
- **Optical alignment**: Adjust for visual weight (icons may need offset for optical centering)
|
|
52
|
+
- **Responsive consistency**: Spacing and alignment work at all breakpoints
|
|
53
|
+
- **Grid adherence**: Elements snap to baseline grid
|
|
54
|
+
|
|
55
|
+
**Check**:
|
|
56
|
+
- Enable grid overlay and verify alignment
|
|
57
|
+
- Check spacing with browser inspector
|
|
58
|
+
- Test at multiple viewport sizes
|
|
59
|
+
- Look for elements that "feel" off
|
|
60
|
+
|
|
61
|
+
### Typography Refinement
|
|
62
|
+
|
|
63
|
+
- **Hierarchy consistency**: Same elements use same sizes/weights throughout
|
|
64
|
+
- **Line length**: 45-75 characters for body text
|
|
65
|
+
- **Line height**: Appropriate for font size and context
|
|
66
|
+
- **Widows & orphans**: No single words on last line
|
|
67
|
+
- **Hyphenation**: Appropriate for language and column width
|
|
68
|
+
- **Kerning**: Adjust letter spacing where needed (especially headlines)
|
|
69
|
+
- **Font loading**: No FOUT/FOIT flashes
|
|
70
|
+
|
|
71
|
+
### Color & Contrast
|
|
72
|
+
|
|
73
|
+
- **Contrast ratios**: All text meets WCAG standards
|
|
74
|
+
- **Consistent token usage**: No hard-coded colors, all use design tokens
|
|
75
|
+
- **Theme consistency**: Works in all theme variants
|
|
76
|
+
- **Color meaning**: Same colors mean same things throughout
|
|
77
|
+
- **Accessible focus**: Focus indicators visible with sufficient contrast
|
|
78
|
+
- **Tinted neutrals**: No pure gray or pure black—add subtle color tint (0.01 chroma)
|
|
79
|
+
- **Gray on color**: Never put gray text on colored backgrounds—use a shade of that color or transparency
|
|
80
|
+
|
|
81
|
+
### Interaction States
|
|
82
|
+
|
|
83
|
+
Every interactive element needs all states:
|
|
84
|
+
|
|
85
|
+
- **Default**: Resting state
|
|
86
|
+
- **Hover**: Subtle feedback (color, scale, shadow)
|
|
87
|
+
- **Focus**: Keyboard focus indicator (never remove without replacement)
|
|
88
|
+
- **Active**: Click/tap feedback
|
|
89
|
+
- **Disabled**: Clearly non-interactive
|
|
90
|
+
- **Loading**: Async action feedback
|
|
91
|
+
- **Error**: Validation or error state
|
|
92
|
+
- **Success**: Successful completion
|
|
93
|
+
|
|
94
|
+
**Missing states create confusion and broken experiences**.
|
|
95
|
+
|
|
96
|
+
### Micro-interactions & Transitions
|
|
97
|
+
|
|
98
|
+
- **Smooth transitions**: All state changes animated appropriately (150-300ms)
|
|
99
|
+
- **Consistent easing**: Use ease-out-quart/quint/expo for natural deceleration. Never bounce or elastic—they feel dated.
|
|
100
|
+
- **No jank**: 60fps animations, only animate transform and opacity
|
|
101
|
+
- **Appropriate motion**: Motion serves purpose, not decoration
|
|
102
|
+
- **Reduced motion**: Respects `prefers-reduced-motion`
|
|
103
|
+
|
|
104
|
+
### Content & Copy
|
|
105
|
+
|
|
106
|
+
- **Consistent terminology**: Same things called same names throughout
|
|
107
|
+
- **Consistent capitalization**: Title Case vs Sentence case applied consistently
|
|
108
|
+
- **Grammar & spelling**: No typos
|
|
109
|
+
- **Appropriate length**: Not too wordy, not too terse
|
|
110
|
+
- **Punctuation consistency**: Periods on sentences, not on labels (unless all labels have them)
|
|
111
|
+
|
|
112
|
+
### Icons & Images
|
|
113
|
+
|
|
114
|
+
- **Consistent style**: All icons from same family or matching style
|
|
115
|
+
- **Appropriate sizing**: Icons sized consistently for context
|
|
116
|
+
- **Proper alignment**: Icons align with adjacent text optically
|
|
117
|
+
- **Alt text**: All images have descriptive alt text
|
|
118
|
+
- **Loading states**: Images don't cause layout shift, proper aspect ratios
|
|
119
|
+
- **Retina support**: 2x assets for high-DPI screens
|
|
120
|
+
|
|
121
|
+
### Forms & Inputs
|
|
122
|
+
|
|
123
|
+
- **Label consistency**: All inputs properly labeled
|
|
124
|
+
- **Required indicators**: Clear and consistent
|
|
125
|
+
- **Error messages**: Helpful and consistent
|
|
126
|
+
- **Tab order**: Logical keyboard navigation
|
|
127
|
+
- **Auto-focus**: Appropriate (don't overuse)
|
|
128
|
+
- **Validation timing**: Consistent (on blur vs on submit)
|
|
129
|
+
|
|
130
|
+
### Edge Cases & Error States
|
|
131
|
+
|
|
132
|
+
- **Loading states**: All async actions have loading feedback
|
|
133
|
+
- **Empty states**: Helpful empty states, not just blank space
|
|
134
|
+
- **Error states**: Clear error messages with recovery paths
|
|
135
|
+
- **Success states**: Confirmation of successful actions
|
|
136
|
+
- **Long content**: Handles very long names, descriptions, etc.
|
|
137
|
+
- **No content**: Handles missing data gracefully
|
|
138
|
+
- **Offline**: Appropriate offline handling (if applicable)
|
|
139
|
+
|
|
140
|
+
### Responsiveness
|
|
141
|
+
|
|
142
|
+
- **All breakpoints**: Test mobile, tablet, desktop
|
|
143
|
+
- **Touch targets**: 44x44px minimum on touch devices
|
|
144
|
+
- **Readable text**: No text smaller than 14px on mobile
|
|
145
|
+
- **No horizontal scroll**: Content fits viewport
|
|
146
|
+
- **Appropriate reflow**: Content adapts logically
|
|
147
|
+
|
|
148
|
+
### Performance
|
|
149
|
+
|
|
150
|
+
- **Fast initial load**: Optimize critical path
|
|
151
|
+
- **No layout shift**: Elements don't jump after load (CLS)
|
|
152
|
+
- **Smooth interactions**: No lag or jank
|
|
153
|
+
- **Optimized images**: Appropriate formats and sizes
|
|
154
|
+
- **Lazy loading**: Off-screen content loads lazily
|
|
155
|
+
|
|
156
|
+
### Code Quality
|
|
157
|
+
|
|
158
|
+
- **Remove console logs**: No debug logging in production
|
|
159
|
+
- **Remove commented code**: Clean up dead code
|
|
160
|
+
- **Remove unused imports**: Clean up unused dependencies
|
|
161
|
+
- **Consistent naming**: Variables and functions follow conventions
|
|
162
|
+
- **Type safety**: No TypeScript `any` or ignored errors
|
|
163
|
+
- **Accessibility**: Proper ARIA labels and semantic HTML
|
|
164
|
+
|
|
165
|
+
## Polish Checklist
|
|
166
|
+
|
|
167
|
+
Go through systematically:
|
|
168
|
+
|
|
169
|
+
- [ ] Visual alignment perfect at all breakpoints
|
|
170
|
+
- [ ] Spacing uses design tokens consistently
|
|
171
|
+
- [ ] Typography hierarchy consistent
|
|
172
|
+
- [ ] All interactive states implemented
|
|
173
|
+
- [ ] All transitions smooth (60fps)
|
|
174
|
+
- [ ] Copy is consistent and polished
|
|
175
|
+
- [ ] Icons are consistent and properly sized
|
|
176
|
+
- [ ] All forms properly labeled and validated
|
|
177
|
+
- [ ] Error states are helpful
|
|
178
|
+
- [ ] Loading states are clear
|
|
179
|
+
- [ ] Empty states are welcoming
|
|
180
|
+
- [ ] Touch targets are 44x44px minimum
|
|
181
|
+
- [ ] Contrast ratios meet WCAG AA
|
|
182
|
+
- [ ] Keyboard navigation works
|
|
183
|
+
- [ ] Focus indicators visible
|
|
184
|
+
- [ ] No console errors or warnings
|
|
185
|
+
- [ ] No layout shift on load
|
|
186
|
+
- [ ] Works in all supported browsers
|
|
187
|
+
- [ ] Respects reduced motion preference
|
|
188
|
+
- [ ] Code is clean (no TODOs, console.logs, commented code)
|
|
189
|
+
|
|
190
|
+
**IMPORTANT**: Polish is about details. Zoom in. Squint at it. Use it yourself. The little things add up.
|
|
191
|
+
|
|
192
|
+
**NEVER**:
|
|
193
|
+
- Polish before it's functionally complete
|
|
194
|
+
- Spend hours on polish if it ships in 30 minutes (triage)
|
|
195
|
+
- Introduce bugs while polishing (test thoroughly)
|
|
196
|
+
- Ignore systematic issues (if spacing is off everywhere, fix the system)
|
|
197
|
+
- Perfect one thing while leaving others rough (consistent quality level)
|
|
198
|
+
|
|
199
|
+
## Final Verification
|
|
200
|
+
|
|
201
|
+
Before marking as done:
|
|
202
|
+
|
|
203
|
+
- **Use it yourself**: Actually interact with the feature
|
|
204
|
+
- **Test on real devices**: Not just browser DevTools
|
|
205
|
+
- **Ask someone else to review**: Fresh eyes catch things
|
|
206
|
+
- **Compare to design**: Match intended design
|
|
207
|
+
- **Check all states**: Don't just test happy path
|
|
208
|
+
|
|
209
|
+
Remember: You have impeccable attention to detail and exquisite taste. Polish until it feels effortless, looks intentional, and works flawlessly. Sweat the details - they matter.
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: pr
|
|
3
|
+
description: "Create a GitHub Pull Request with auto-generated title and description from current branch changes. Use this skill whenever the user mentions PR, pull request, wants to submit code for review, or says things like 'open a PR', 'create PR', 'submit for review', 'push and PR', or 'quick-pr'. Also trigger when user has finished work on a branch and wants to share it."
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Quick PR — Auto-Generate Pull Requests
|
|
7
|
+
|
|
8
|
+
Create a GitHub Pull Request for the current branch with an intelligently generated title and description based on actual code changes.
|
|
9
|
+
|
|
10
|
+
## Process
|
|
11
|
+
|
|
12
|
+
### 1. Analyze Changes
|
|
13
|
+
|
|
14
|
+
Gather all the context needed to write a good PR description:
|
|
15
|
+
|
|
16
|
+
```bash
|
|
17
|
+
git status
|
|
18
|
+
git diff main...HEAD
|
|
19
|
+
git log main..HEAD --oneline
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
If the base branch isn't `main`, check for `master` or ask the user.
|
|
23
|
+
|
|
24
|
+
### 2. Generate PR Content
|
|
25
|
+
|
|
26
|
+
From the diff and commit history, produce:
|
|
27
|
+
|
|
28
|
+
- **Title**: Clear, imperative mood, under 72 chars (e.g., "Add user authentication with JWT tokens")
|
|
29
|
+
- **Summary**: What this PR does and why — 1-3 sentences
|
|
30
|
+
- **Key changes**: Bullet list of the most important modifications
|
|
31
|
+
- **Breaking changes**: Flag anything that could break existing functionality
|
|
32
|
+
- **Migration notes**: If schema, config, or API changes need action
|
|
33
|
+
|
|
34
|
+
### 3. Create the PR
|
|
35
|
+
|
|
36
|
+
```bash
|
|
37
|
+
gh pr create --title "title" --body "$(cat <<'EOF'
|
|
38
|
+
## Summary
|
|
39
|
+
[What this PR does and why]
|
|
40
|
+
|
|
41
|
+
## Changes
|
|
42
|
+
- [Key change 1]
|
|
43
|
+
- [Key change 2]
|
|
44
|
+
|
|
45
|
+
## Testing
|
|
46
|
+
- [ ] Tested locally
|
|
47
|
+
- [ ] Tests pass
|
|
48
|
+
|
|
49
|
+
## Notes
|
|
50
|
+
[Any additional context, breaking changes, migration needs]
|
|
51
|
+
EOF
|
|
52
|
+
)"
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
### 4. Return the PR URL
|
|
56
|
+
|
|
57
|
+
After creation, display the PR URL so the user can share it or continue working.
|
|
58
|
+
|
|
59
|
+
## Arguments
|
|
60
|
+
|
|
61
|
+
If the user provides arguments (e.g., a target branch, reviewers, labels), incorporate them into the `gh pr create` command:
|
|
62
|
+
|
|
63
|
+
- `--base <branch>` for target branch
|
|
64
|
+
- `--reviewer <user>` for reviewers
|
|
65
|
+
- `--label <label>` for labels
|
|
66
|
+
- `--draft` for draft PRs
|