Update README.md and improve .ai-assistant.md documentation
This commit is contained in:
@ -20,7 +20,7 @@ We follow [Semantic Versioning](https://semver.org/):
|
||||
|
||||
### When to Increment Version Numbers
|
||||
|
||||
- **PATCH** (1.6.0 → 1.6.1):
|
||||
- **PATCH** (1.6.0 → 1.6.1):
|
||||
- Bug fixes
|
||||
- Small text changes
|
||||
- Minor improvements that don't add new features
|
||||
@ -41,7 +41,10 @@ When updating the version number, always update these files:
|
||||
1. `fix-plugin-does-not-exist-notices.php` (Plugin header)
|
||||
2. `CHANGELOG.md` (Add new version section)
|
||||
3. `readme.txt` (Stable tag and Changelog section)
|
||||
4. Update `FPDEN_VERSION` constant in the main plugin file
|
||||
4. `README.md` (Update Changelog section to match readme.txt)
|
||||
5. Update `FPDEN_VERSION` constant in the main plugin file
|
||||
|
||||
**IMPORTANT**: Always ensure README.md is kept in sync with readme.txt for consistency across platforms.
|
||||
|
||||
## Git Workflow
|
||||
|
||||
@ -58,23 +61,41 @@ When updating the version number, always update these files:
|
||||
- Keep the first line under 50 characters
|
||||
- Reference issues when relevant: "Fix #123: Resolve plugin detection issue"
|
||||
|
||||
### Pre-Release Checklist
|
||||
|
||||
Before creating a new release, verify the following:
|
||||
|
||||
- [ ] Determine the correct version increment (MAJOR, MINOR, or PATCH) based on the changes
|
||||
- [ ] Ensure all changes are documented in CHANGELOG.md
|
||||
- [ ] Verify all code changes are tested and working correctly
|
||||
- [ ] Check that all files are properly formatted and follow WordPress coding standards
|
||||
- [ ] Ensure Git Updater configuration is correct (if applicable)
|
||||
|
||||
### Release Process
|
||||
|
||||
1. Create a new branch for the version: `git checkout -b v{MAJOR}.{MINOR}.{PATCH}`
|
||||
2. Update version numbers in all required files
|
||||
2. Update version numbers in ALL required files:
|
||||
- `fix-plugin-does-not-exist-notices.php` (Plugin header)
|
||||
- `FPDEN_VERSION` constant in the main plugin file
|
||||
- `readme.txt` (Stable tag)
|
||||
- `README.md` (Ensure changelog is updated)
|
||||
- Any other files that reference the version number
|
||||
3. Update CHANGELOG.md with all changes
|
||||
4. Commit changes: `git commit -m "Prepare release v{MAJOR}.{MINOR}.{PATCH}"`
|
||||
5. Push branch to all remotes:
|
||||
4. Update readme.txt changelog section
|
||||
5. Update README.md changelog section to match readme.txt
|
||||
6. Commit changes: `git commit -m "Prepare release v{MAJOR}.{MINOR}.{PATCH}"`
|
||||
7. Push branch to all remotes:
|
||||
```
|
||||
git push github HEAD:v{MAJOR}.{MINOR}.{PATCH}
|
||||
git push gitea HEAD:v{MAJOR}.{MINOR}.{PATCH}
|
||||
```
|
||||
6. Create and push a tag to trigger the GitHub Actions workflow:
|
||||
8. Create and push a tag to trigger the GitHub Actions workflow:
|
||||
```
|
||||
git tag -a v{MAJOR}.{MINOR}.{PATCH} -m "Release version {MAJOR}.{MINOR}.{PATCH}"
|
||||
git push github refs/tags/v{MAJOR}.{MINOR}.{PATCH}
|
||||
git push gitea refs/tags/v{MAJOR}.{MINOR}.{PATCH}
|
||||
```
|
||||
9. Verify the GitHub Actions workflow completes successfully
|
||||
|
||||
## Build Process
|
||||
|
||||
@ -122,10 +143,11 @@ Before releasing:
|
||||
# 1. Create a new branch
|
||||
git checkout -b v1.7.0
|
||||
|
||||
# 2. Update version numbers in files
|
||||
# 2. Update version numbers in ALL required files
|
||||
# - fix-plugin-does-not-exist-notices.php
|
||||
# - CHANGELOG.md
|
||||
# - readme.txt
|
||||
# - README.md
|
||||
# - FPDEN_VERSION constant
|
||||
|
||||
# 3. Commit changes
|
||||
|
Reference in New Issue
Block a user