Skip to content

Commit c4eb86c

Browse files
committed
docs: update release process documentation with GitHub setup instructions and release notes template
1 parent a9cc4c0 commit c4eb86c

File tree

3 files changed

+108
-330
lines changed

3 files changed

+108
-330
lines changed

CHANGELOG.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ Initial release of the Multi-Block Plugin Scaffold - a comprehensive WordPress p
1212
### Added
1313

1414
#### Core Generator System
15+
1516
- Dual-mode generator supporting both template mode (`--in-place`) and output folder mode (default `generated-plugins/`)
1617
- Interactive confirmation prompt for template mode with safe default "No" to prevent accidental scaffold destruction
1718
- Mustache template system with 6 transformation filters: `upper`, `lower`, `pascalCase`, `camelCase`, `kebabCase`, `snakeCase`
@@ -20,12 +21,14 @@ Initial release of the Multi-Block Plugin Scaffold - a comprehensive WordPress p
2021
- Template variable validation system ensuring correct mustache usage throughout
2122

2223
#### Example Blocks
24+
2325
- **Card Block** - Display single items with featured image, title, excerpt, and custom fields
2426
- **Collection Block** - Grid/list layouts with pagination, filtering, and query controls
2527
- **Slider Block** - Carousel with autoplay, navigation, and responsive controls
2628
- **Featured Block** - Highlight selected items with custom layouts
2729

2830
#### Architecture & Infrastructure
31+
2932
- Custom post type and taxonomy scaffolding with full WordPress registration
3033
- Secure Custom Fields (SCF) integration with local JSON sync
3134
- Block patterns system with 7 pre-built patterns
@@ -36,6 +39,7 @@ Initial release of the Multi-Block Plugin Scaffold - a comprehensive WordPress p
3639
- Options pages with settings API integration
3740

3841
#### Development Tools
42+
3943
- Comprehensive unit test suite: 130 tests across 7 suites (Jest + @wordpress/scripts)
4044
- Linting infrastructure: ESLint (JS), Stylelint (CSS), PHPCS (PHP), PHPStan (static analysis)
4145
- Build system with webpack 5, Babel, and PostCSS
@@ -44,6 +48,7 @@ Initial release of the Multi-Block Plugin Scaffold - a comprehensive WordPress p
4448
- wp-env integration for local WordPress development environment
4549

4650
#### Documentation
51+
4752
- 15 comprehensive documentation files covering all aspects:
4853
- ARCHITECTURE.md - Repository structure and organization
4954
- GENERATE-PLUGIN.md - Complete plugin generation guide
@@ -57,6 +62,7 @@ Initial release of the Multi-Block Plugin Scaffold - a comprehensive WordPress p
5762
### Changed
5863

5964
#### Repository Organization
65+
6066
- Reorganized directory structure:
6167
- `bin/``scripts/` for better clarity
6268
- `parts/``template-parts/` for WordPress standard naming
@@ -66,6 +72,7 @@ Initial release of the Multi-Block Plugin Scaffold - a comprehensive WordPress p
6672
- Consolidated GENERATE-PLUGIN.md from 4 methods to 2 operational modes
6773

6874
#### Code Quality
75+
6976
- Standardized all text domains to `{{textdomain}}` mustache template (474 instances)
7077
- Corrected POST_TYPE constants to use `{{slug}}` instead of text domain
7178
- Fixed default postType parameters in hooks to use `{{slug}}`
@@ -82,6 +89,7 @@ Initial release of the Multi-Block Plugin Scaffold - a comprehensive WordPress p
8289
### Documentation
8390

8491
#### New Documentation Files
92+
8593
- `docs/ARCHITECTURE.md` - Complete repository structure guide
8694
- `docs/BUILD-PROCESS.md` - Build system detailed documentation
8795
- `docs/GENERATE-PLUGIN.md` - Plugin generation comprehensive guide
@@ -90,13 +98,15 @@ Initial release of the Multi-Block Plugin Scaffold - a comprehensive WordPress p
9098
- `generated-plugins/README.md` - Output directory usage instructions
9199

92100
#### Enhanced Documentation
101+
93102
- README.md: Added "Using This Scaffold" section with workflow examples
94103
- GENERATE-PLUGIN.md: Consolidated to 2 clear operational modes
95104
- All docs include frontmatter metadata for better organization
96105

97106
### Technical Details
98107

99108
#### Supported Features
109+
100110
- WordPress 6.5+ (Block Bindings API, Plugin Dependencies)
101111
- PHP 8.0+ requirement
102112
- Node.js 18+ for build system
@@ -110,6 +120,7 @@ Initial release of the Multi-Block Plugin Scaffold - a comprehensive WordPress p
110120
- Options pages with settings API
111121

112122
#### Build System
123+
113124
- Webpack 5 with optimized production builds
114125
- Babel transpilation for modern JavaScript
115126
- PostCSS with autoprefixer and cssnano
@@ -118,6 +129,7 @@ Initial release of the Multi-Block Plugin Scaffold - a comprehensive WordPress p
118129
- Asset extraction and optimization
119130

120131
#### Testing Infrastructure
132+
121133
- Jest unit tests for JavaScript
122134
- PHPUnit for PHP
123135
- Playwright for E2E tests
@@ -160,21 +172,27 @@ Developed by [LightSpeed](https://lightspeedwp.agency) for the WordPress communi
160172
## [Unreleased]
161173

162174
### Added
175+
163176
- Nothing yet
164177

165178
### Changed
179+
166180
- Nothing yet
167181

168182
### Fixed
183+
169184
- Nothing yet
170185

171186
### Deprecated
187+
172188
- Nothing yet
173189

174190
### Removed
191+
175192
- Nothing yet
176193

177194
### Security
195+
178196
- Nothing yet
179197

180198
---

0 commit comments

Comments
 (0)