本文へ移動
cccskills
無料GitHub で公開

dev-workflow

The complete development workflow for SkillHub contributors including local dev, staging validation, testing, and PR creation. Ensures agents follow the correct sequence of steps.

インストール方法を見る

含まれるファイル(1)

  • SKILL.md6.5 KB

SKILL.md(原文)

インストールする前に、エージェントに与えられる指示の中身を確認できます。

Development Workflow Skill

Trigger

Use this skill when:

  • Starting local development
  • Running tests or validation
  • Preparing a pull request
  • Setting up the development environment
  • Working with parallel agent worktrees

Prerequisites

  • Java 21+ (java -version)
  • Maven wrapper (./mvnw in server/)
  • Node.js + pnpm
  • Docker + docker compose
  • gh CLI (for PR creation)
  • curl (for smoke tests and health checks)

Workflow Stages

Stage 1: Local Development (fast iteration)

One-command start:

make dev-all          # Start full stack: Postgres, Redis, MinIO, scanner, backend, frontend
make dev-all-down     # Stop everything
make dev-all-reset    # Full reset (clears data volumes)
make dev-status       # Check service status

Access points:

  • Web UI: http://localhost:3000
  • Backend API: http://localhost:8080
  • Scanner: http://localhost:8000

Individual components:

make dev              # Start dependency services only (Postgres, Redis, MinIO, scanner)
make dev-server       # Start backend in foreground (blocking)
make dev-web          # Start Vite dev server (HMR enabled)
make dev-server-restart # Restart backend process
make dev-down         # Stop dependency services
make dev-logs         # View backend logs (use SERVICE=frontend for frontend logs)

Backend development: After editing Java code, run make dev-server-restart.

Frontend development: Vite HMR enabled — save a file for instant browser updates.

Scanner: The security scanner is enabled by default in dev. Health checked at http://localhost:8000/health.

Stage 2: Testing

CommandScopeNotes
make test-backend-appBackend unit testsskillhub-app + dependencies (-am)
make test-backendAll backend modulesAll modules via ./mvnw test
make test-frontendFrontend unit testsVitest (pnpm run test)
make test-e2e-frontendFrontend E2E testsPlaywright
make test-e2e-smoke-frontendFrontend E2E smokePlaywright subset
make typecheck-webTypeScript type checktsc --noEmit
make lint-webESLint checkFrontend linting

Important: Never run ./mvnw -pl skillhub-app clean test directly under server/. Use -am or Makefile targets to include dependent modules.

Stage 3: Staging Regression (pre-PR validation)

make staging          # Build backend Docker image + frontend static + smoke test
make staging-down     # Tear down
make staging-logs     # View backend logs
SERVICE=web make staging-logs  # View Nginx logs

Staging validates the containerized deployment path:

  • Backend: built as Docker image from local source (Dockerfile.dev)
  • Frontend: built as static files (pnpm build), served by Nginx
  • Dependencies: same Postgres/Redis/MinIO as local dev
  • Smoke test runs against staging via scripts/smoke-test.sh

Staging URLs:

  • Web UI: http://localhost
  • Backend API: http://localhost:8080

Staging credentials (for bootstrap admin):

  • Username: admin
  • Password: Admin@staging2026

Stage 4: Pull Request

make pr               # Push branch + create PR (requires gh CLI)

Requirements:

  • gh CLI installed and authenticated
  • Not on main/master branch
  • All changes committed (will prompt if uncommitted changes exist)

Useful Commands

CommandDescription
make generate-apiRegenerate OpenAPI types from running backend
make namespace-smokeNamespace workflow smoke test
make db-resetReset database only (Flyway migrate)
make validate-release-configValidate release env vars (.env.release)
./scripts/smoke-test.shBasic API smoke test (health, auth, labels)
./scripts/namespace-smoke-test.shNamespace CRUD + membership smoke test
./scripts/check-openapi-generated.shVerify OpenAPI types are not stale
make parallel-init TASK=nameCreate parallel worktree for agent

Mock Auth Users

User IDRoleHeader
local-userRegular userX-Mock-User-Id: local-user
local-adminSuper adminX-Mock-User-Id: local-admin

Bootstrap admin (local profile):

  • Username: admin
  • Password: ChangeMe!2026

Smoke Test Coverage

scripts/smoke-test.sh validates:

  1. Health endpoint (/actuator/health → 200)
  2. Prometheus metrics (/actuator/prometheus → 200)
  3. Namespaces API (/api/v1/namespaces → 200)
  4. Auth required (/api/v1/auth/me → 401 without session)
  5. User registration flow (with CSRF)
  6. Auth me with session
  7. Password change
  8. Logout + verify 401 after
  9. Admin login
  10. Label CRUD (admin only)

Additional smoke tests:

  • scripts/namespace-smoke-test.sh — Namespace creation, membership, publishing
  • scripts/governance-smoke-test.sh — Governance and moderation
  • scripts/promotion-smoke-test.sh — Skill promotion between scopes

Parallel Agent Workflow

For parallel agent development with isolated worktrees:

make parallel-init TASK=feature-name           # Create worktree
make parallel-sync SOURCES="feat1 feat2"       # Merge feature branches
make parallel-up SOURCES="feat1 feat2"         # Merge + start dev environment
make parallel-down                             # Stop parallel environment

See docs/13-parallel-workflow.md for full details.

Commit Style

Use conventional commit format:

<type>(<scope>): <description>

Examples:

feat(auth): add local account login
fix(publish): resolve null pointer when skill metadata is missing name
docs(deploy): clarify runtime image usage
test(namespace): add membership service edge case tests
refactor(review): extract query repository for governance list
chore(ci): add parallel workflow scripts

Common Issues

IssueSolution
Backend won't startCheck Java version (java -version), must be 21+
Port 8080 in uselsof -i :8080 to find and kill the process
Maven download timeoutConfigure mirror in ~/.m2/settings.xml
Frontend won't startRun make web-deps to ensure node_modules exist
Staging build failsCheck Dockerfile.dev and ensure Maven build succeeds first
CSRF errors in testsEnsure cookie jar is shared and CSRF token refreshed after login

レビュー

まだレビューはありません。使ってみた感想をお寄せください。

同じリポジトリのスキル

概要と使いどころ

Evaluate factual claims in AI-generated text and teach a lightweight verification habit. Use when a learner wants to fact-check an AI answer, identify uncertainty, choose appropriate independent sources, or practise critical AI literacy.

日本語の概要は準備中です。原文の説明を表示しています。

iflytek/skillhub5,1692026年10月10日 更新

API design conventions, namespace coordinate system, RBAC roles, ClawHub compatibility layer, OpenAPI contract sync rules, and CSRF/session handling.

日本語の概要は準備中です。原文の説明を表示しています。

iflytek/skillhub5,1692026年10月10日 更新

Rules for the SkillHub backend Maven multi-module clean architecture. Ensures agents place new code in the correct module and respect dependency direction.

日本語の概要は準備中です。原文の説明を表示しています。

iflytek/skillhub5,1692026年10月10日 更新

Code style, logging, and testing conventions for SkillHub backend (Java) and frontend (TypeScript). Use when writing or reviewing code.

日本語の概要は準備中です。原文の説明を表示しています。

iflytek/skillhub5,1692026年10月10日 更新

Parse and understand an HTTP(S) URL or an authorized local document, audio, or video source through Cue Omni Reader when the Agent has the official Omni MCP tools.

日本語の概要は準備中です。原文の説明を表示しています。

iflytek/skillhub5,1692026年10月10日 更新

Generate concise daily standups, reflection prompts, and weekly retrospectives for individuals or teams. Use for planning a day, surfacing blockers, reviewing user-provided entries, or drafting a check-in without assuming prior history.

日本語の概要は準備中です。原文の説明を表示しています。

iflytek/skillhub5,1692026年10月10日 更新

iflytek のスキルをすべて見る

このスキルの問題を報告する