Update documentation to ensure README.md changelog is maintained

This commit is contained in:
2025-04-14 22:33:59 +01:00
parent 65f784a461
commit ef3108113e
2 changed files with 26 additions and 4 deletions

View File

@ -23,13 +23,15 @@ Detailed workflow documentation is available in the `.ai-workflows/` directory:
## Version Management ## Version Management
We follow [Semantic Versioning](https://semver.org/): We follow [Semantic Versioning](https://semver.org/):
- **MAJOR.MINOR.PATCH** (e.g., 2.2.1) - **MAJOR.MINOR.PATCH** (e.g., 2.2.2)
- **MAJOR**: Breaking changes - **MAJOR**: Breaking changes
- **MINOR**: New features, non-breaking - **MINOR**: New features, non-breaking
- **PATCH**: Bug fixes, non-breaking - **PATCH**: Bug fixes, non-breaking
When updating version numbers, see **@.ai-workflows/release-process.md** for the complete checklist. When updating version numbers, see **@.ai-workflows/release-process.md** for the complete checklist.
**IMPORTANT**: Always keep the changelogs in README.md, readme.txt, and CHANGELOG.md in sync to avoid confusion. All three files must be updated with the same changes for each release.
## Git Workflow ## Git Workflow
### Branch Naming Convention ### Branch Naming Convention

View File

@ -90,7 +90,24 @@ All notable changes to this project should be documented both here and in the ma
Note: Use the `####` heading format for consistency with the existing CHANGELOG.md structure. Note: Use the `####` heading format for consistency with the existing CHANGELOG.md structure.
#### d. POT File (languages/wp-fix-plugin-does-not-exist-notices.pot) #### d. README.md
Update the Changelog section in the main README.md file to match the changes in readme.txt:
```markdown
## Changelog
### {MAJOR}.{MINOR}.{PATCH}
* Change 1
* Change 2
* Change 3
### {PREVIOUS_VERSION}
```
**IMPORTANT**: Always keep the changelogs in README.md, readme.txt, and CHANGELOG.md in sync to avoid confusion.
#### e. POT File (languages/wp-fix-plugin-does-not-exist-notices.pot)
Update the Project-Id-Version and POT-Creation-Date (IMPORTANT - don't forget this step!): Update the Project-Id-Version and POT-Creation-Date (IMPORTANT - don't forget this step!):
@ -101,7 +118,7 @@ Update the Project-Id-Version and POT-Creation-Date (IMPORTANT - don't forget th
Note: Always use the current date for POT-Creation-Date in the format YYYY-MM-DD. Note: Always use the current date for POT-Creation-Date in the format YYYY-MM-DD.
#### e. readme.txt #### f. readme.txt
Update the stable tag: Update the stable tag:
@ -142,10 +159,12 @@ Test the plugin thoroughly in your local WordPress environment:
### 4. Commit Changes ### 4. Commit Changes
```bash ```bash
git add wp-fix-plugin-does-not-exist-notices.php CHANGELOG.md readme.txt admin/js/version-fix.js languages/wp-fix-plugin-does-not-exist-notices.pot git add wp-fix-plugin-does-not-exist-notices.php CHANGELOG.md README.md readme.txt languages/wp-fix-plugin-does-not-exist-notices.pot
git commit -m "Version {MAJOR}.{MINOR}.{PATCH} - Brief description of changes" git commit -m "Version {MAJOR}.{MINOR}.{PATCH} - Brief description of changes"
``` ```
Note: Make sure to include README.md in your commit to keep all changelog files in sync.
### 5. Create a Tag ### 5. Create a Tag
```bash ```bash
@ -195,6 +214,7 @@ The `--no-ff` flag creates a merge commit even if a fast-forward merge is possib
- [ ] Verify that the plugin was deployed to WordPress.org (if applicable) - [ ] Verify that the plugin was deployed to WordPress.org (if applicable)
- [ ] Test the plugin from the GitHub release ZIP to ensure it works correctly - [ ] Test the plugin from the GitHub release ZIP to ensure it works correctly
- [ ] Verify that Git Updater can detect and install the new version - [ ] Verify that Git Updater can detect and install the new version
- [ ] Confirm that all changelog files (README.md, readme.txt, and CHANGELOG.md) are in sync
## Testing Previous Versions ## Testing Previous Versions