GitHub - rittou/code-review-skill · GitHub
Skip to content

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

17 Commits

Folders and files

Repository files navigation

shopware-review

Codex skill for two focused Shopware workflows:

  • review code with tests and runtime evidence
  • build an isolated QA environment per PR or ticket

What is special here

  • one QA namespace per PR or ticket
  • stable QA runtime root at ~/qa/<slug>
  • auto reuse of the current linked/system worktree when it already matches the Shopware repo
  • source-root .qa/current pointer back to the runtime root for quick reopening from the active checkout
  • Docker and OrbStack URLs use the same slug while the database stays on the familiar shopware name inside each isolated DB container
  • demo data implies indexing when storefront visibility depends on it
  • demo data can trigger storefront-ready verification so seeded products are proven visible, not just generated
  • the same source worktree can continue into follow-up fixes and retesting

Repo layout

shopware-review/
├── SKILL.md
├── README.md
├── agents/
│   └── openai.yaml
├── scripts/
│   └── qa-env.sh
└── references/
    ├── business-context-review.md
    ├── code-architecture-review.md
    ├── code-cleanliness-review.md
    ├── code-logic-review.md
    ├── code-style-review.md
    ├── native-functions-review.md
    ├── performance-review.md
    ├── qa-process.md
    ├── review-output-template.md
    ├── security-review.md
    ├── shopware-core-qa.md
    ├── software-design-principles.md
    └── test-coverage-review.md

Use

Review code with tests:

Use $shopware-review to review this code change in general.
Run the relevant tests, use Docker-based validation when helpful, and return the findings, measured test evidence, and any remaining unverified risk.

Build a dev environment:

Use $shopware-review to build the Shopware dev environment for this PR.
Choose the right setup path from the diff, prepare demo data only when needed, and always run indexing together with demo data so storefront results are visible.
Return the environment access details plus the observed runtime status.

QA helper

The core helper is scripts/qa-env.sh.

Typical flow:

scripts/qa-env.sh create \
  --repo ~/work/shopware-main \
  --ref origin/pull/123/head \
  --source-root-mode auto \
  --branch qa/pr-123-swag-456 \
  --pr 123 \
  --ticket SWAG-456

scripts/qa-env.sh access --slug pr-123-swag-456
scripts/qa-env.sh run --slug pr-123-swag-456 -- pwd
scripts/qa-env.sh git --slug pr-123-swag-456 -- status --short
scripts/qa-env.sh compose --slug pr-123-swag-456 -- ps
scripts/qa-env.sh app --slug pr-123-swag-456 -- bin/console about
scripts/qa-env.sh cleanup --slug pr-123-swag-456

The helper supports:

  • auto, fe-light, be-light, be-fresh, search-indexed
  • auto, managed, system, and current source-root selection
  • named QA branches for follow-up fixes
  • access output with source root, runtime root, app/adminer/mailer URLs, full DB access details, and next steps
  • .qa/current and .qa/<slug> pointers inside the active source root
  • optional storefront-ready verification after setup, demo data, and indexing

References

Install

Symlink into Codex skills:

mkdir -p "${CODEX_HOME:-$HOME/.codex}/skills"
ln -s /path/to/shopware-review "${CODEX_HOME:-$HOME/.codex}/skills/shopware-review"

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages