Skip to content

Validation and Contributing

Gaurav Tiwari edited this page Sep 19, 2026 · 1 revision

Validation and Contributing

Keep maintained rules in the skill source and use the wiki to explain workflows. Do not create a second, conflicting serialization manual in a converter or generated bundle.

Repository layout

Path Purpose
skills/generateblocks-layouts/ Shared authoring contract, references, examples and helper scripts
Other skills/*/ folders Converter entrypoints and source-specific mappings
importable/ Generated .zip and matching .skill distributions
reports/ Recorded tests, measurements and their limits
Root examples/ Historical exploration/exports; check their stated status before reuse
CHANGELOG.md Versioned repository changes

Test a change

From the repository root:

python3 skills/generateblocks-layouts/scripts/test_tools.py
python3 skills/generateblocks-layouts/scripts/preflight.py \
  output/layout.html --id-scope YOUR_LAYOUT_SCOPE
python3 skills/generateblocks-layouts/scripts/verify_roundtrip.py \
  --local output/submitted.html --remote output/readback.html

The first command tests helper behavior. The second checks a generated file's common hazards. The third checks transport integrity when you have a real saved readback. Replace example filenames/scope values with your actual test artifacts.

For unfamiliar markup, validate through the installed WordPress editor. Check expected content as well as validity. Test the states affected by your change, such as a dark ancestor rule or an expanded accordion; do not claim a broad audit from a narrow test.

Package from source

bash build-bundles.sh

The builder checks archive members against the source. Each converter archive carries a generated layout dependency under references/generateblocks-layouts/. Edit the main layout skill once and rebuild; do not edit those packaged copies separately. The .skill and .zip pair must be byte-identical.

Refresh the installed client copies after changing source and confirm they contain the references and helper scripts. Keep local customizations recoverable rather than overwriting them accidentally.

Good changes and issue reports

Prefer a small correction backed by a reproducible problem. Include:

  • Plugin/core versions and the affected theme or client when relevant.
  • The smallest source or generated fixture that demonstrates the problem.
  • Expected behavior, actual behavior and the checks performed.
  • Whether it affects instructions, helper code, packaging or runtime output.

Use GitHub issues and pull requests for improvements. Do not include credentials, tokens, protected cookies, private post content or proprietary Pro source files. The repository's licensing statement applies to its own materials; vendor files have their own terms.

Editing this wiki

GitHub maintains the wiki in a separate repository:

git clone https://github.com/wpgaurav/generateblocks-skills.wiki.git

Maintain _Sidebar.md when adding a page and keep existing page slugs where possible. Check internal page links, linked source paths and runnable examples before publishing. Updating the wiki does not update release archives; changing skill source requires the normal packaging workflow.


Back to wiki home · Reference library

Clone this wiki locally