Skip to content

README.md

Latest commit

 

History

History
41 lines (33 loc) · 1.57 KB

README.md

File metadata and controls

41 lines (33 loc) · 1.57 KB

Bootstrap Shortcodes Development Workflow

Welcome to the development repository for the Bootstrap Shortcodes WordPress Plugin.

Git Flow & Contributing

This repository strictly adheres to Git Flow:

  1. No direct commits to master. The master branch is protected.
  2. For all changes, checkout a new branch from master (e.g., feature/awesome-new-button or fix/button-styling).
  3. Commit your changes logically and atomically. Do not include unrelated files or business/personal notes.
  4. Push your branch and open a Pull Request against master.
  5. Automated CI/CD pipelines will run against your Pull Request. Once CI passes and the PR is reviewed, it may be merged.

Repository Hygiene

Only development, testing, and project-related files are permitted in this repository. Never commit business communications, credentials, or unrelated documents.

Local QA Testing

For local testing, we use @wordpress/env. See the detailed workflow for instructions on spinning up the local test site.

Automated Testing

This repository includes automated tests using PHPUnit for PHP logic and Playwright for End-to-End (E2E) testing. Both suites run inside the local @wordpress/env Docker environment.

Setup

Install dependencies and initiate the test container:

npm install
npx wp-env start
npx wp-env run tests-cli \
  --env-cwd=wp-content/plugins/bootstrap-shortcodes \
  composer install

Running Tests

To run the PHPUnit test suite:

npm run test:php

To run the Playwright E2E test suite:

npm run test:e2e