Skip to content

chore: refactor project structure and developer tooling#11

Merged
danish17 merged 1 commit intodevelopfrom
chore/tooling-refactor
Feb 3, 2026
Merged

chore: refactor project structure and developer tooling#11
danish17 merged 1 commit intodevelopfrom
chore/tooling-refactor

Conversation

@danish17
Copy link
Copy Markdown
Collaborator

@danish17 danish17 commented Feb 3, 2026

Description

This PR creates a 'Specimen' standard for the project by refactoring the codebase, enhancing documentation, and implementing modern developer tooling.

Key Changes

🏗️ Architecture & PHP

  • PSR-4 Autoloading: Moved to root . Implemented standard Composer PSR-4 autoloading and removed the custom autoloader.
  • Namespace Updates: Updated all PHP classes and traits to use the new namespace structure.

📚 Documentation

  • New docs/ Directory: Split documentation into specialized files:
    • INSTALLATION.md: Setup guides.
    • USAGE.md: Block attributes and patterns.
    • THEMING.md: CSS variables and style overrides.
    • API.md: Developer context and Interactivity API details.
    • CONTRIBUTING.md: Guidelines for contributors.
  • .DEVELOPMENT.md: Added a comprehensive command reference for build tools and workflows.
  • .README.md: Streamlined to serve as a high-level entry point.

🛠️ Tooling & CI/CD

  • Makefile: Added make dev (fast), make build (prod), and make zip (release) for automated workflows.
  • Commitlint & Husky: Enforced Conventional Commits and pre-commit linting.
  • Conventional Changelog: Added automated changelog generation.
  • GitHub Actions: Added release.yml to automate releases on merges to production.
  • Local Simulation: Added support for act to test workflows locally.

🧹 Code Quality

  • Fixed linting errors in Interactivity API view scripts (view.ts).

- Move PHP files to root 'inc/' directory and implement PSR-4 autoloading.
- Standardize autoloading using Composer and remove custom autoloader.
- Add comprehensive documentation in 'docs/' and 'DEVELOPMENT.md'.
- Implement 'conventional-changelog' and 'commitlint' for standardized versioning.
- Add 'Makefile' for automated builds and distribution.
- Configure GitHub Actions workflow for automated releases on 'production'.
- Add 'act' support for local workflow simulation.
- Fix linting errors in Interactivity API view script.
@danish17 danish17 requested a review from theMasudRana February 3, 2026 01:58
Copy link
Copy Markdown
Collaborator

@theMasudRana theMasudRana left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@danish17 danish17 merged commit 9050c20 into develop Feb 3, 2026
1 check passed
@danish17 danish17 deleted the chore/tooling-refactor branch February 3, 2026 09:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants