Install
This is the repository archive. It installs, but the folder name will carry the branch suffix and updates will not flow.
Install straight from GitHub with WP-CLI:
wp plugin install https://github.com/jahidhasan018/smart-woocommerce-faq/archive/refs/heads/develop.zipA developer-friendly WooCommerce FAQ plugin: central FAQ library, product/category/tag/variation assignment, display engine, Gutenberg blocks, AI generation (BYOK), search, analytics, and more. Built with TDD + SOLID + OOP for WP.org distribution.
Status: In planning/foundation. See
openspec/ROADMAP.mdfor current state.
Setup
Requires Node.js, npm, Composer, and Docker.
composer install
npm install
npm run env:start # boots wp-env (WordPress + WooCommerce in Docker)
npm run env:cli -- wp wc install # WooCommerce sample data
Test
composer test:unit # PHPUnit, no WP bootstrap (Brain\Monkey)
composer test:integration # PHPUnit against live wp-env instance
composer stan # PHPStan (level defined in phpstan.neon.dist)
composer cs # WPCS via PHP_CodeSniffer
npm run test:e2e # Playwright against wp-env
WP-CLI
The plugin ships its own WP-CLI commands. Run them via wp-env:
npm run env:cli -- wp wsfq <subcommand>
See .opencode/skills/wp-cli/SKILL.md for the command list and conventions.
Agent skills (WordPress/agent-skills)
The project uses the official WordPress/agent-skills repository to give AI coding assistants (Claude, Cursor, Codex, VS Code/Copilot, etc.) expert-level WordPress knowledge.
These skills are intentionally NOT committed to this repo. They are installed locally and gitignored (.claude/skills/, .codex/, .cursor/skills/, .github/skills/). After a fresh clone, or in a new dev environment, reinstall them with the steps below.
Installed skills
wordpress-router— classifies the repo and routes to the right workflowwp-project-triage— detects project type, tooling, and versionswp-plugin-development— plugin architecture, hooks, Settings API, securitywp-block-development— Gutenberg blocks:block.json, attributes, rendering, deprecationswp-rest-api— REST API routes, schema, auth, response shapingwp-wpcli-and-ops— WP-CLI commands and automationwp-performance— profiling, caching, database optimizationwp-phpstan— PHPStan config, baselines, WP-specific typingwp-plugin-directory-guidelines— WordPress Plugin Directory Guidelineswpds— WordPress Design System
Install (one-time, per environment)
# 1. Clone the skills repo somewhere outside this project (e.g. /tmp)
git clone https://github.com/WordPress/agent-skills.git
cd agent-skills
# 2. Build the distribution
node shared/scripts/skillpack-build.mjs --clean
# 3. Install the skills into this repo (project-scoped, gitignored)
node shared/scripts/skillpack-install.mjs \
--dest=<path/to/smart-woocommerce-faq> \
--targets=claude,cursor,codex,vscode \
--skills=wordpress-router,wp-project-triage,wp-plugin-development,wp-block-development,wp-rest-api,wp-wpcli-and-ops,wp-performance,wp-phpstan,wp-plugin-directory-guidelines,wpds
Or install globally so they're available across all your projects:
node shared/scripts/skillpack-install.mjs --global
# or, for a specific set:
node shared/scripts/skillpack-install.mjs --global --skills=wp-plugin-development,wp-rest-api,wp-wpcli-and-ops
To see all available skills: node shared/scripts/skillpack-install.mjs --list
OpenSpec commands
The /opsx-* agent commands and skill files are auto-generated by the openspec CLI and are gitignored. After a fresh clone, regenerate them with openspec update in the repo root (once the openspec CLI is installed globally). Never hand-edit the per-tool copies.
Project-scoped vs global
- Project-scoped (the default above) installs into
.claude/skills/,.codex/,.cursor/skills/,.github/skills/inside this repo. They're gitignored here on purpose. - Global installs to
~/.claude/skills/,~/.cursor/skills/, etc., available in every repo. - When a skill exists in both scopes, the project-level version wins.
Docs
openspec/ROADMAP.md— current status of every feature and build phaseopenspec/specs/— durable behavior contract, one file per capabilityopenspec/DECISIONS.md— architecture decision recordsAGENTS.md— instructions for AI coding assistants (read this first)ARCHITECTURE.md— module mapskills/— on-demand agent skills, now under.opencode/skills/(e.g.wp-cli/SKILL.md)
Contributing
See CONTRIBUTING.md.
License
GPL-2.0-or-later (for WP.org distribution).