Version 2.3.0 - Improved development workflow documentation
This commit is contained in:
@ -19,6 +19,8 @@ Detailed workflow documentation is available in the `.ai-workflows/` directory:
|
||||
- **@.ai-workflows/dev-prefs-memory.md**: Persistent memory of developer preferences
|
||||
- **@.ai-workflows/feature-development.md**: Process for developing new features
|
||||
- **@.ai-workflows/folder-structure.md**: Documentation of the plugin's folder structure and naming conventions
|
||||
- **@.ai-workflows/git-workflow.md**: Detailed git workflow and branch management guidelines
|
||||
- **@.ai-workflows/incremental-development.md**: Time-efficient approach for incremental development and testing
|
||||
- **@.ai-workflows/local-env-vars.md**: Local development environment paths and URLs
|
||||
- **@.ai-workflows/release-process.md**: Steps for preparing and publishing releases
|
||||
|
||||
@ -30,15 +32,35 @@ We follow [Semantic Versioning](https://semver.org/):
|
||||
- **MINOR**: New features, non-breaking
|
||||
- **PATCH**: Bug fixes, non-breaking
|
||||
|
||||
### Time-Efficient Development Workflow
|
||||
|
||||
For efficient development and testing:
|
||||
- Create descriptive branches (**fix/**, **feature/**, **patch/**, **refactor/**) without version numbers
|
||||
- **Don't update version numbers** during initial development and testing
|
||||
- Only create **version branches** (v2.2.3) and update version numbers when changes are confirmed working
|
||||
- Use **patch** increments for bug fixes, **minor** for features, and **major** for breaking changes
|
||||
- Mark versions as **stable** when confirmed working by the user
|
||||
- See **@.ai-workflows/incremental-development.md** for detailed guidelines
|
||||
|
||||
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
|
||||
|
||||
Detailed git workflow documentation is available in **@.ai-workflows/git-workflow.md**.
|
||||
|
||||
### Key Principles
|
||||
- Always pull the latest main branch from origin before creating new branches (mandatory step)
|
||||
- Create one branch per issue/feature (fix/patch/feature)
|
||||
- Submit one pull/merge request per issue
|
||||
- Run CI/CD checks for each pull request
|
||||
- Create separate branches for suggested improvements outside the current issue
|
||||
|
||||
### Branch Naming Convention
|
||||
- Feature branches: `feature/descriptive-name`
|
||||
- Bug fix branches: `fix/issue-description`
|
||||
- Bug fix branches: `fix/issue-description` or `fix/issue-number-description`
|
||||
- Patch branches: `patch/descriptive-name`
|
||||
- Release branches: `v{MAJOR}.{MINOR}.{PATCH}`
|
||||
|
||||
### Commit Message Guidelines
|
||||
|
@ -6,15 +6,17 @@ This document provides guidance for AI assistants to help with bug fixing for th
|
||||
|
||||
### 1. Create a Bug Fix Branch
|
||||
|
||||
Always start by creating a bug fix branch from the main branch:
|
||||
Always start by creating a bug fix branch from the latest main branch pulled from origin (this step is mandatory):
|
||||
|
||||
```bash
|
||||
git checkout main
|
||||
git pull github main
|
||||
git pull origin main # Critical step - never skip this
|
||||
git checkout -b fix/bug-description
|
||||
```
|
||||
|
||||
Use a descriptive name that clearly indicates what bug is being fixed.
|
||||
Use a descriptive name that clearly indicates what bug is being fixed. If there's an issue number, include it in the branch name (e.g., `fix/123-plugin-activation-error`).
|
||||
|
||||
For more detailed git workflow guidelines, see **@.ai-workflows/git-workflow.md**.
|
||||
|
||||
### 2. Understand the Bug
|
||||
|
||||
@ -99,13 +101,18 @@ If the repository uses pull requests for code review, create a pull request from
|
||||
|
||||
## Determining Version Increment
|
||||
|
||||
After fixing a bug, determine the appropriate version increment:
|
||||
After fixing a bug and confirming it works, determine the appropriate version increment:
|
||||
|
||||
- **PATCH** (e.g., 1.6.0 → 1.6.1): For most bug fixes that don't change functionality
|
||||
- **IMPORTANT**: Always increment the patch version for every change, even small ones, to make rollbacks easier if issues are found in testing
|
||||
- **MINOR** (e.g., 1.6.0 → 1.7.0): For bug fixes that introduce new features or significant changes
|
||||
- **MAJOR** (e.g., 1.6.0 → 2.0.0): For bug fixes that introduce breaking changes
|
||||
|
||||
**IMPORTANT**: Don't update version numbers during initial development and testing. Only create a version branch (e.g., `v2.2.3`) and update version numbers when the fix is confirmed working.
|
||||
|
||||
This approach is more time-efficient as it allows you to focus on fixing the bug without worrying about version updates until the fix is confirmed working.
|
||||
|
||||
For detailed guidelines on time-efficient development and testing, see **@.ai-workflows/incremental-development.md**.
|
||||
|
||||
## Testing Previous Versions
|
||||
|
||||
To test a previous version of the plugin:
|
||||
|
@ -6,15 +6,17 @@ This document provides guidance for AI assistants to help with feature developme
|
||||
|
||||
### 1. Create a Feature Branch
|
||||
|
||||
Always start by creating a feature branch from the main branch:
|
||||
Always start by creating a feature branch from the latest main branch pulled from origin (this step is mandatory):
|
||||
|
||||
```bash
|
||||
git checkout main
|
||||
git pull github main
|
||||
git pull origin main # Critical step - never skip this
|
||||
git checkout -b feature/descriptive-name
|
||||
```
|
||||
|
||||
Use a descriptive name that clearly indicates what the feature is about.
|
||||
Use a descriptive name that clearly indicates what the feature is about. If there's an issue number, include it in the branch name (e.g., `feature/123-update-source-selector`).
|
||||
|
||||
For more detailed git workflow guidelines, see **@.ai-workflows/git-workflow.md**.
|
||||
|
||||
### 2. Implement the Feature
|
||||
|
||||
@ -58,21 +60,39 @@ git commit -m "Add feature: descriptive name"
|
||||
|
||||
When the feature is ready to be released:
|
||||
|
||||
1. Create a version branch for the release:
|
||||
1. Create a version branch with the appropriate version number (typically increment the minor version for features):
|
||||
|
||||
```bash
|
||||
git checkout -b v{MAJOR}.{MINOR}.{PATCH}
|
||||
# Example: from 2.2.0 to 2.3.0
|
||||
git checkout -b v{MAJOR}.{MINOR+1}.0
|
||||
```
|
||||
|
||||
2. Merge your feature branch into the version branch:
|
||||
2. Now update version numbers in all required files:
|
||||
|
||||
- Main plugin file (wp-fix-plugin-does-not-exist-notices.php)
|
||||
- CHANGELOG.md (add a new version section)
|
||||
- readme.txt
|
||||
- README.md
|
||||
- languages/wp-fix-plugin-does-not-exist-notices.pot (Project-Id-Version)
|
||||
|
||||
3. Commit the version updates:
|
||||
|
||||
```bash
|
||||
git merge feature/descriptive-name --no-ff
|
||||
git add .
|
||||
git commit -m "Version {MAJOR}.{MINOR+1}.0 - [brief description]"
|
||||
```
|
||||
|
||||
3. Update version numbers and changelog entries
|
||||
4. Tag the version as stable:
|
||||
|
||||
4. Follow the standard release process from this point
|
||||
```bash
|
||||
git tag -a v{MAJOR}.{MINOR+1}.0-stable -m "Stable version {MAJOR}.{MINOR+1}.0"
|
||||
```
|
||||
|
||||
5. Follow the standard release process from this point
|
||||
|
||||
**IMPORTANT**: Don't update version numbers during initial development and testing. Only create a version branch and update version numbers when the feature is confirmed working.
|
||||
|
||||
For detailed guidelines on time-efficient development and testing, see **@.ai-workflows/incremental-development.md**.
|
||||
|
||||
### 7. Push to Remote (Optional for Collaboration)
|
||||
|
||||
|
255
.ai-workflows/git-workflow.md
Normal file
255
.ai-workflows/git-workflow.md
Normal file
@ -0,0 +1,255 @@
|
||||
# Git Workflow Guide for AI Assistants
|
||||
|
||||
This document provides guidance for AI assistants to help with git workflow management for the Fix Plugin Does Not Exist Notices plugin.
|
||||
|
||||
## Core Git Workflow Principles
|
||||
|
||||
### 1. Always Start from Latest Main Branch
|
||||
|
||||
Before creating any new branch, always ensure you're working with the latest code from the main branch by pulling from the origin:
|
||||
|
||||
```bash
|
||||
git checkout main
|
||||
git pull origin main
|
||||
```
|
||||
|
||||
This critical step ensures that your new branch includes all the latest changes from the remote repository and reduces the chance of merge conflicts later. Never skip this step, as working from an outdated main branch can lead to integration problems.
|
||||
|
||||
### 2. One Issue Per Branch
|
||||
|
||||
Create a separate branch for each issue or feature you're working on:
|
||||
|
||||
- For bug fixes: `fix/issue-description` or `fix/issue-number-description`
|
||||
- For features: `feature/descriptive-name`
|
||||
- For small improvements: `patch/descriptive-name`
|
||||
- For code restructuring: `refactor/descriptive-name`
|
||||
|
||||
**Important**: Use descriptive names without version numbers for development branches. This allows focusing on the changes without worrying about version updates until the changes are confirmed working.
|
||||
|
||||
Only create version branches (e.g., `v2.2.3`) when changes are ready for release, and only then update version numbers in files.
|
||||
|
||||
This approach keeps changes focused, makes code review easier, and provides clear rollback points if needed.
|
||||
|
||||
### 3. Pull Request for Each Issue
|
||||
|
||||
Create a separate pull request for each issue or feature. This ensures:
|
||||
|
||||
- Each change can be reviewed independently
|
||||
- Issues can be merged as soon as they're ready
|
||||
- Changes can be reverted individually if needed
|
||||
- CI/CD checks can run on focused changes
|
||||
|
||||
## Detailed Workflow
|
||||
|
||||
### Starting a New Task
|
||||
|
||||
1. **Update Main Branch from Origin**
|
||||
```bash
|
||||
git checkout main
|
||||
git pull origin main
|
||||
```
|
||||
|
||||
This step is mandatory before creating any new branch to ensure you're working with the latest code.
|
||||
|
||||
2. **Create a New Branch**
|
||||
```bash
|
||||
git checkout -b [branch-type]/[description]
|
||||
```
|
||||
|
||||
Examples:
|
||||
```bash
|
||||
git checkout -b fix/123-plugin-activation-error
|
||||
git checkout -b feature/update-source-selector
|
||||
git checkout -b patch/2.2.1
|
||||
```
|
||||
|
||||
3. **Make Your Changes**
|
||||
- Make focused changes related only to the specific issue
|
||||
- Commit regularly with clear, descriptive messages
|
||||
- Reference issue numbers in commit messages when applicable
|
||||
|
||||
4. **Testing Approach**
|
||||
|
||||
For efficient development:
|
||||
- **Local Testing (Default)**: Test without updating version numbers
|
||||
```bash
|
||||
# Get current version from plugin file
|
||||
CURRENT_VERSION=$(grep -o "Version: [0-9.]*" wp-fix-plugin-does-not-exist-notices.php | cut -d' ' -f2)
|
||||
|
||||
# Build and deploy with current version
|
||||
./build.sh $CURRENT_VERSION
|
||||
```
|
||||
- **Remote Testing (When Requested)**: Push development branch to remote
|
||||
```bash
|
||||
git add .
|
||||
git commit -m "[Brief description] for remote testing"
|
||||
git push origin [branch-name]
|
||||
```
|
||||
- **Version Creation**: Only when changes are confirmed working
|
||||
```bash
|
||||
# Create version branch
|
||||
git checkout -b v{MAJOR}.{MINOR}.{PATCH}
|
||||
|
||||
# Update version numbers in all required files
|
||||
# Commit version updates
|
||||
git add .
|
||||
git commit -m "Version {MAJOR}.{MINOR}.{PATCH} - Brief description"
|
||||
|
||||
# Tag as stable
|
||||
git tag -a v{MAJOR}.{MINOR}.{PATCH}-stable -m "Stable version {MAJOR}.{MINOR}.{PATCH}"
|
||||
```
|
||||
|
||||
5. **Push Branch to Remote (When Needed)**
|
||||
```bash
|
||||
git push origin [branch-name]
|
||||
```
|
||||
|
||||
### Creating a Pull Request
|
||||
|
||||
1. **Ensure Tests Pass Locally**
|
||||
- Run any available tests to ensure your changes work as expected
|
||||
- Fix any issues before creating a pull request
|
||||
|
||||
2. **Create Pull Request**
|
||||
- Create a pull request from your branch to the main branch
|
||||
- Include a clear description of the changes
|
||||
- Reference any related issues
|
||||
- Assign reviewers if appropriate
|
||||
|
||||
3. **Address Review Feedback**
|
||||
- Make requested changes
|
||||
- Push additional commits to the same branch
|
||||
- Respond to comments
|
||||
|
||||
### CI/CD Integration
|
||||
|
||||
Each pull request should pass through CI/CD checks before being merged. This ensures that all changes are compatible with the existing codebase and meet quality standards.
|
||||
|
||||
1. **Automated Tests**
|
||||
- Unit tests
|
||||
- Integration tests
|
||||
- Code style checks
|
||||
- Compatibility checks
|
||||
|
||||
2. **Manual Review**
|
||||
- Code review by team members
|
||||
- Functional testing in test environment
|
||||
- Verification of feature requirements
|
||||
|
||||
3. **Approval Process**
|
||||
- Required approvals before merging
|
||||
- Final checks for conflicts with other pending PRs
|
||||
- Verification that all CI/CD checks have passed
|
||||
|
||||
4. **Compatibility with Unmerged PRs**
|
||||
- When multiple PRs are in progress simultaneously, ensure each PR is compatible with the main branch
|
||||
- For related changes, consider using feature flags to allow independent merging
|
||||
- Document dependencies between PRs in the PR description
|
||||
|
||||
### Handling Concurrent Development
|
||||
|
||||
When working on multiple issues simultaneously:
|
||||
|
||||
1. **Keep Branches Independent**
|
||||
- Always create new branches from the latest main branch pulled from origin, not from other feature branches
|
||||
- This ensures each PR can be merged independently and contains all the latest changes
|
||||
|
||||
2. **Handle Conflicts Proactively**
|
||||
- If main has been updated with other changes while you're working:
|
||||
```bash
|
||||
git checkout main
|
||||
git pull origin main
|
||||
git checkout your-branch
|
||||
git merge main
|
||||
```
|
||||
- Resolve any conflicts locally before pushing
|
||||
|
||||
3. **Coordinate on Dependent Changes**
|
||||
- If changes depend on each other, note this in the PR description
|
||||
- Consider using the "Depends on #PR-number" notation in PR descriptions
|
||||
|
||||
## Release Process
|
||||
|
||||
When preparing for a release:
|
||||
|
||||
1. **Ensure All Required PRs are Merged**
|
||||
- All features and fixes planned for the release should be merged to main
|
||||
|
||||
2. **Create a Release Branch**
|
||||
```bash
|
||||
git checkout main
|
||||
git pull origin main
|
||||
git checkout -b v{MAJOR}.{MINOR}.{PATCH}
|
||||
```
|
||||
|
||||
3. **Follow Standard Release Process**
|
||||
- Update version numbers
|
||||
- Update changelogs
|
||||
- Create tag
|
||||
- See **@.ai-workflows/release-process.md** for complete details
|
||||
|
||||
## Contributing to External Repositories
|
||||
|
||||
When working on issues for external repositories (pull/merge requests):
|
||||
|
||||
### 1. Clearly Indicate Testing Status
|
||||
|
||||
In the PR description and comments, clearly indicate the testing status:
|
||||
|
||||
- **Not tested**: "This PR addresses [issue] but has not been tested locally or remotely. It's ready for community/maintainer testing."
|
||||
- **Locally tested**: "This PR has been tested in a local WordPress environment and [describe results]."
|
||||
- **Remotely tested**: "This PR has been tested with a remote build and [describe results]."
|
||||
|
||||
### 2. Provide Testing Instructions
|
||||
|
||||
Include clear instructions for maintainers on how to test the changes:
|
||||
|
||||
- Steps to reproduce the original issue (if applicable)
|
||||
- Steps to verify the fix or feature
|
||||
- Any specific environments or configurations needed for testing
|
||||
|
||||
### 3. Be Responsive to Feedback
|
||||
|
||||
Monitor the PR for feedback from maintainers and be prepared to make additional changes if requested.
|
||||
|
||||
## Best Practices
|
||||
|
||||
### Commit Messages
|
||||
|
||||
- Use present tense ("Add feature" not "Added feature")
|
||||
- Start with a verb
|
||||
- Keep the first line under 50 characters
|
||||
- Reference issues when relevant: "Fix #123: Resolve plugin detection issue"
|
||||
- For more complex changes, add a detailed description after the first line
|
||||
|
||||
### Branch Management
|
||||
|
||||
- Delete branches after they've been merged
|
||||
- Keep branch names descriptive but concise
|
||||
- Use consistent naming conventions
|
||||
|
||||
### Code Review
|
||||
|
||||
- Review code thoroughly before approving
|
||||
- Test changes locally when possible
|
||||
- Provide constructive feedback
|
||||
- See **@.ai-workflows/code-review.md** for detailed code review guidelines
|
||||
|
||||
### Suggested Improvements
|
||||
|
||||
If you identify potential improvements outside the scope of the current issue:
|
||||
|
||||
1. **Document the Suggestion**
|
||||
- Note the suggestion in the PR comments
|
||||
- Create a new issue for the suggestion
|
||||
- Be specific about the benefits and implementation details
|
||||
|
||||
2. **Create a Separate Branch**
|
||||
- Don't include unrelated improvements in the current PR
|
||||
- Create a new branch from the latest main branch for the suggested improvement
|
||||
- Submit a separate PR for the suggestion
|
||||
|
||||
3. **Ensure Compatibility**
|
||||
- Make sure the suggested improvement is compatible with any unmerged PRs
|
||||
- If the improvement depends on changes in another PR, note this dependency
|
||||
- Consider how the improvement will interact with other pending changes
|
225
.ai-workflows/incremental-development.md
Normal file
225
.ai-workflows/incremental-development.md
Normal file
@ -0,0 +1,225 @@
|
||||
# Incremental Development and Testing Guide
|
||||
|
||||
This document provides guidance for AI assistants to help with incremental development and testing for the Fix Plugin Does Not Exist Notices plugin.
|
||||
|
||||
## Time-Efficient Development Principles
|
||||
|
||||
### Branch Naming for Development
|
||||
|
||||
1. **Initial Development Branches**
|
||||
- Use descriptive names without version numbers:
|
||||
- `fix/issue-description` - For bug fixes
|
||||
- `feature/descriptive-name` - For new features
|
||||
- `patch/descriptive-name` - For small improvements
|
||||
- `refactor/descriptive-name` - For code restructuring
|
||||
- **Don't update version numbers** during this phase
|
||||
- Focus on implementing and testing the changes
|
||||
|
||||
2. **Version Branches**
|
||||
- Only create after changes are confirmed working:
|
||||
- `v{MAJOR}.{MINOR}.{PATCH}` (e.g., `v2.2.3`)
|
||||
- Only update version numbers at this point
|
||||
- This minimizes unnecessary version updates
|
||||
|
||||
### Version Numbering Guidelines
|
||||
|
||||
1. **Patch Versions (X.Y.Z → X.Y.Z+1)**
|
||||
- Use for bug fixes and small improvements
|
||||
- Example: `v2.2.3`
|
||||
|
||||
2. **Minor Versions (X.Y.Z → X.Y+1.0)**
|
||||
- Use for new features or significant improvements
|
||||
- Example: `v2.3.0`
|
||||
|
||||
3. **Major Versions (X.Y.Z → X+1.0.0)**
|
||||
- Only increment when numerous features and fixes are tested and confirmed stable
|
||||
- Reserved for breaking changes or significant overhauls
|
||||
- Example: `v3.0.0`
|
||||
|
||||
### Marking Stable Versions
|
||||
|
||||
When the user confirms that changes are working correctly:
|
||||
1. Create a version branch and update version numbers
|
||||
2. Tag the version branch as stable
|
||||
```bash
|
||||
git tag -a v{MAJOR}.{MINOR}.{PATCH}-stable -m "Stable version {MAJOR}.{MINOR}.{PATCH}"
|
||||
```
|
||||
3. Document in the PR or issue that this version has been confirmed stable
|
||||
|
||||
## Local Testing Workflow
|
||||
|
||||
### 1. Create a Descriptive Branch for Development
|
||||
|
||||
```bash
|
||||
# Ensure you have the latest main branch
|
||||
git checkout main
|
||||
git pull origin main
|
||||
|
||||
# Create a descriptive branch (without version numbers)
|
||||
git checkout -b fix/plugin-activation-error
|
||||
```
|
||||
|
||||
### 2. Make Changes Without Updating Version Numbers
|
||||
|
||||
During the development and testing phase:
|
||||
- Implement the necessary changes
|
||||
- **Don't update version numbers** in any files yet
|
||||
- Focus on the functionality
|
||||
|
||||
### 3. Build and Deploy Locally
|
||||
|
||||
For local testing, use the current version number from the main plugin file:
|
||||
|
||||
```bash
|
||||
# Get the current version from the plugin file
|
||||
CURRENT_VERSION=$(grep -o "Version: [0-9.]*" wp-fix-plugin-does-not-exist-notices.php | cut -d' ' -f2)
|
||||
|
||||
# Build and deploy with current version
|
||||
./build.sh $CURRENT_VERSION
|
||||
```
|
||||
|
||||
This will:
|
||||
1. Create a build directory
|
||||
2. Copy required files to the build directory
|
||||
3. Deploy the plugin to your local WordPress testing environment
|
||||
|
||||
**Note**: For local testing iterations, you do not need to commit changes, push to remote repositories, or create tags unless specifically requested.
|
||||
|
||||
### 4. Test and Evaluate
|
||||
|
||||
Test the changes thoroughly in the local environment:
|
||||
- Verify that the specific issue is fixed or feature works as expected
|
||||
- Check for any regressions or new issues
|
||||
- Document the results
|
||||
|
||||
### 5. Based on Testing Results
|
||||
|
||||
- **If changes need further refinement**: Continue working in the same branch
|
||||
- **If changes work as expected**: Proceed to version branch creation
|
||||
|
||||
### 6. Creating a Version Branch
|
||||
|
||||
When changes are confirmed working and ready for release:
|
||||
|
||||
1. Create a version branch with the appropriate version number:
|
||||
|
||||
```bash
|
||||
# Determine the appropriate version increment (patch, minor, or major)
|
||||
# based on the nature of the changes
|
||||
git checkout -b v{MAJOR}.{MINOR}.{PATCH}
|
||||
```
|
||||
|
||||
2. Now update version numbers in all required files:
|
||||
|
||||
- Main plugin file (wp-fix-plugin-does-not-exist-notices.php)
|
||||
- CHANGELOG.md (add a new version section)
|
||||
- readme.txt
|
||||
- README.md
|
||||
- languages/wp-fix-plugin-does-not-exist-notices.pot (Project-Id-Version)
|
||||
|
||||
3. Commit the version updates:
|
||||
|
||||
```bash
|
||||
git add .
|
||||
git commit -m "Version {MAJOR}.{MINOR}.{PATCH} - [brief description]"
|
||||
```
|
||||
|
||||
4. Tag the version as stable:
|
||||
|
||||
```bash
|
||||
git tag -a v{MAJOR}.{MINOR}.{PATCH}-stable -m "Stable version {MAJOR}.{MINOR}.{PATCH}"
|
||||
```
|
||||
|
||||
## Remote Testing Workflow
|
||||
|
||||
When the user specifically requests remote testing:
|
||||
|
||||
### 1. Commit Changes to Remote Repository
|
||||
|
||||
If testing a development branch (without version updates):
|
||||
|
||||
```bash
|
||||
git add .
|
||||
git commit -m "[brief description] for remote testing"
|
||||
git push origin [branch-name]
|
||||
```
|
||||
|
||||
If testing a version branch (with version updates):
|
||||
|
||||
```bash
|
||||
git add .
|
||||
git commit -m "Version {MAJOR}.{MINOR}.{PATCH} - [brief description]"
|
||||
git push origin v{MAJOR}.{MINOR}.{PATCH}
|
||||
```
|
||||
|
||||
### 2. Create and Push Tag (For Version Branches Only)
|
||||
|
||||
```bash
|
||||
git tag -a v{MAJOR}.{MINOR}.{PATCH} -m "Version {MAJOR}.{MINOR}.{PATCH} for remote testing"
|
||||
git push origin v{MAJOR}.{MINOR}.{PATCH}
|
||||
```
|
||||
|
||||
This will trigger GitHub Actions to build the installable ZIP file.
|
||||
|
||||
### 3. Verify Remote Build
|
||||
|
||||
Check that the GitHub Actions workflow completed successfully and the ZIP file is available for download.
|
||||
|
||||
### 4. Test and Evaluate
|
||||
|
||||
Test the remotely built version and document the results.
|
||||
|
||||
## Contributing to External Repositories
|
||||
|
||||
When working on issues for external repositories (pull/merge requests):
|
||||
|
||||
### 1. Clearly Indicate Testing Status
|
||||
|
||||
In the PR description and comments, clearly indicate the testing status:
|
||||
|
||||
- **Not tested**: "This PR addresses [issue] but has not been tested locally or remotely. It's ready for community/maintainer testing."
|
||||
- **Locally tested**: "This PR has been tested in a local WordPress environment and [describe results]."
|
||||
- **Remotely tested**: "This PR has been tested with a remote build and [describe results]."
|
||||
|
||||
### 2. Provide Testing Instructions
|
||||
|
||||
Include clear instructions for maintainers on how to test the changes:
|
||||
|
||||
- Steps to reproduce the original issue (if applicable)
|
||||
- Steps to verify the fix or feature
|
||||
- Any specific environments or configurations needed for testing
|
||||
|
||||
### 3. Be Responsive to Feedback
|
||||
|
||||
Monitor the PR for feedback from maintainers and be prepared to make additional changes if requested.
|
||||
|
||||
## Rollback Procedure
|
||||
|
||||
If a change causes issues after release:
|
||||
|
||||
### 1. Identify the Last Stable Version
|
||||
|
||||
Find the last version that was marked as stable:
|
||||
|
||||
```bash
|
||||
git tag -l "*-stable"
|
||||
```
|
||||
|
||||
### 2. Create a New Branch from the Stable Version
|
||||
|
||||
```bash
|
||||
git checkout v{MAJOR}.{MINOR}.{PATCH}-stable
|
||||
git checkout -b fix/rollback-based-fix
|
||||
```
|
||||
|
||||
### 3. Make Necessary Changes
|
||||
|
||||
Implement the fix based on the stable version. Don't update version numbers yet.
|
||||
|
||||
### 4. Test the Changes
|
||||
|
||||
Test thoroughly to ensure the fix resolves the issues.
|
||||
|
||||
### 5. When Confirmed Working
|
||||
|
||||
Create a version branch with an incremented patch version and update all version numbers as described in the "Creating a Version Branch" section.
|
@ -9,6 +9,8 @@ This directory contains workflow documentation for AI assistants working with th
|
||||
- **dev-prefs-memory.md**: Persistent memory of developer preferences
|
||||
- **feature-development.md**: Process for developing new features
|
||||
- **folder-structure.md**: Documentation of the plugin's folder structure and naming conventions
|
||||
- **git-workflow.md**: Detailed git workflow and branch management guidelines
|
||||
- **incremental-development.md**: Time-efficient approach for incremental development and testing
|
||||
- **local-env-vars.md**: Local development environment paths and URLs
|
||||
- **release-process.md**: Steps for preparing and publishing new releases
|
||||
|
||||
|
@ -15,31 +15,53 @@ This document provides step-by-step instructions for AI assistants to help with
|
||||
Based on the changes made, determine the appropriate version increment:
|
||||
|
||||
1. **PATCH** (e.g., 1.6.0 → 1.6.1): For bug fixes and minor improvements
|
||||
- **IMPORTANT**: Always increment the patch version for every change, even small ones, to make rollbacks easier if issues are found in testing
|
||||
2. **MINOR** (e.g., 1.6.0 → 1.7.0): For new features and significant improvements
|
||||
3. **MAJOR** (e.g., 1.6.0 → 2.0.0): For breaking changes
|
||||
- Only increment when numerous features and fixes are tested and confirmed stable
|
||||
|
||||
**IMPORTANT**: For time-efficient development:
|
||||
- Use descriptive branches (`fix/`, `feature/`, `patch/`, `refactor/`) without version numbers during development
|
||||
- Don't update version numbers during initial development and testing
|
||||
- Only create version branches (e.g., `v2.2.3`) and update version numbers when changes are confirmed working
|
||||
|
||||
This approach allows focusing on the changes without worrying about version updates until they're ready for release.
|
||||
|
||||
For detailed guidelines on time-efficient development and testing, see **@.ai-workflows/incremental-development.md**.
|
||||
|
||||
## Release Steps
|
||||
|
||||
### 1. Start from a Feature Branch or Create a New Branch
|
||||
### 1. Create a Version Branch
|
||||
|
||||
You can either use an existing feature branch or create a new branch specifically for the release:
|
||||
When changes are confirmed working and ready for release:
|
||||
|
||||
```bash
|
||||
# Option 1: Use existing feature branch
|
||||
git checkout feature/branch-name
|
||||
# First, ensure you have the latest main branch
|
||||
git checkout main
|
||||
git pull origin main
|
||||
|
||||
# Option 2: Create a new branch
|
||||
# Option 1: If you're coming from a development branch
|
||||
git checkout fix/your-fix-branch # or feature/your-feature-branch
|
||||
|
||||
# Option 2: Create a version branch directly from main
|
||||
git checkout -b v{MAJOR}.{MINOR}.{PATCH}
|
||||
```
|
||||
|
||||
Example:
|
||||
```bash
|
||||
git checkout feature/refactor-and-improvements
|
||||
# or
|
||||
git checkout -b v2.2.1
|
||||
git checkout main
|
||||
git pull origin main
|
||||
|
||||
# If coming from a development branch
|
||||
git checkout feature/add-new-selector
|
||||
|
||||
# Create the version branch
|
||||
git checkout -b v2.3.0
|
||||
```
|
||||
|
||||
**IMPORTANT**: The version branch is where you'll update all version numbers. This should only be done after the changes have been tested and confirmed working.
|
||||
|
||||
For more detailed git workflow guidelines, see **@.ai-workflows/git-workflow.md**.
|
||||
|
||||
### 2. Update Version Numbers
|
||||
|
||||
Update the version number in the following files:
|
||||
@ -135,9 +157,11 @@ Add a new entry to the changelog section:
|
||||
* Change 3
|
||||
```
|
||||
|
||||
### 3. Build and Test Locally
|
||||
### 3. Build and Test
|
||||
|
||||
Run the build script to create the plugin ZIP file and deploy to your local WordPress testing environment:
|
||||
#### Local Testing (Default for Incremental Development)
|
||||
|
||||
For incremental development and testing, only local testing is required unless specifically requested:
|
||||
|
||||
```bash
|
||||
./build.sh {MAJOR}.{MINOR}.{PATCH}
|
||||
@ -156,6 +180,17 @@ Test the plugin thoroughly in your local WordPress environment:
|
||||
- Check for any PHP warnings or notices
|
||||
- Test any specific changes made in this version
|
||||
|
||||
#### Remote Testing (When Specifically Requested)
|
||||
|
||||
When the user specifically requests remote testing, follow these additional steps after local testing:
|
||||
|
||||
1. Commit changes to the remote repository
|
||||
2. Create and push a tag
|
||||
3. Verify that GitHub Actions builds the installable ZIP file
|
||||
4. Test the remotely built version
|
||||
|
||||
This is necessary when testing Git Updater integration or other features that require the plugin to be installed from a remote source.
|
||||
|
||||
### 4. Commit Changes
|
||||
|
||||
```bash
|
||||
@ -171,6 +206,17 @@ Note: Make sure to include README.md in your commit to keep all changelog files
|
||||
git tag -a v{MAJOR}.{MINOR}.{PATCH} -m "Version {MAJOR}.{MINOR}.{PATCH} - Brief description of changes"
|
||||
```
|
||||
|
||||
#### Marking a Version as Stable
|
||||
|
||||
When the user confirms that a version is working correctly and stable:
|
||||
|
||||
```bash
|
||||
# Create a stable tag for easy reference
|
||||
git tag -a v{MAJOR}.{MINOR}.{PATCH}-stable -m "Stable version {MAJOR}.{MINOR}.{PATCH}"
|
||||
```
|
||||
|
||||
This provides a clear reference point for stable versions that can be used for rollbacks if needed.
|
||||
|
||||
### 6. Push Branch and Tag to Remotes
|
||||
|
||||
```bash
|
||||
@ -215,6 +261,7 @@ The `--no-ff` flag creates a merge commit even if a fast-forward merge is possib
|
||||
- [ ] Test the plugin from the GitHub release ZIP to ensure it works correctly
|
||||
- [ ] 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
|
||||
- [ ] Verify that all CI/CD checks have passed for the release
|
||||
|
||||
## Testing Previous Versions
|
||||
|
||||
|
10
CHANGELOG.md
10
CHANGELOG.md
@ -1,5 +1,15 @@
|
||||
All notable changes to this project should be documented both here and in the main Readme files.
|
||||
|
||||
#### [2.3.0] - 2025-04-15
|
||||
#### Added
|
||||
- Improved time-efficient development workflow documentation
|
||||
- New git workflow guidelines for better branch management
|
||||
- Comprehensive incremental development approach
|
||||
|
||||
#### Improved
|
||||
- Documentation for local vs. remote testing
|
||||
- Version management process for more efficient development
|
||||
|
||||
#### [2.2.5] - 2025-04-14
|
||||
#### Added
|
||||
- Documentation for the developer preferences memory file in .ai-workflows/
|
||||
|
@ -234,6 +234,13 @@ For more information on Git Updater integration, see the [Git Updater Required H
|
||||
|
||||
## Changelog
|
||||
|
||||
### 2.3.0
|
||||
* Added: Improved time-efficient development workflow documentation
|
||||
* Added: New git workflow guidelines for better branch management
|
||||
* Added: Comprehensive incremental development approach
|
||||
* Improved: Documentation for local vs. remote testing
|
||||
* Improved: Version management process for more efficient development
|
||||
|
||||
### 2.2.5
|
||||
* Added: Documentation for the developer preferences memory file in .ai-workflows/
|
||||
* Improved: AI assistant instructions for maintaining developer preferences
|
||||
|
@ -2,14 +2,14 @@
|
||||
# This file is distributed under the GPL-2.0+.
|
||||
msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: Fix 'Plugin file does not exist' Notices 2.2.5\n"
|
||||
"Project-Id-Version: Fix 'Plugin file does not exist' Notices 2.3.0\n"
|
||||
"Report-Msgid-Bugs-To: https://wordpress.org/support/plugin/wp-fix-plugin-does-not-exist-notices\n"
|
||||
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
||||
"Language-Team: LANGUAGE <LL@li.org>\n"
|
||||
"MIME-Version: 1.0\n"
|
||||
"Content-Type: text/plain; charset=UTF-8\n"
|
||||
"Content-Transfer-Encoding: 8bit\n"
|
||||
"POT-Creation-Date: 2025-04-14T00:00:00+00:00\n"
|
||||
"POT-Creation-Date: 2025-04-15T00:00:00+00:00\n"
|
||||
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
||||
"X-Generator: WP-CLI 2.9.0\n"
|
||||
"X-Domain: wp-fix-plugin-does-not-exist-notices\n"
|
||||
|
@ -5,7 +5,7 @@ Tags: plugins, missing plugins, cleanup, error fix, admin tools, plugin file doe
|
||||
Requires at least: 5.0
|
||||
Tested up to: 6.7.2
|
||||
Requires PHP: 7.0
|
||||
Stable tag: 2.2.5
|
||||
Stable tag: 2.3.0
|
||||
License: GPL-2.0+
|
||||
License URI: https://www.gnu.org/licenses/gpl-2.0.html
|
||||
|
||||
@ -179,6 +179,13 @@ Manually editing the WordPress database is risky and requires technical knowledg
|
||||
|
||||
== Changelog ==
|
||||
|
||||
= 2.3.0 =
|
||||
* Added: Improved time-efficient development workflow documentation
|
||||
* Added: New git workflow guidelines for better branch management
|
||||
* Added: Comprehensive incremental development approach
|
||||
* Improved: Documentation for local vs. remote testing
|
||||
* Improved: Version management process for more efficient development
|
||||
|
||||
= 2.2.5 =
|
||||
* Added: Documentation for the developer preferences memory file in .ai-workflows/
|
||||
* Improved: AI assistant instructions for maintaining developer preferences
|
||||
|
@ -3,7 +3,7 @@
|
||||
* Plugin Name: Fix 'Plugin file does not exist' Notices
|
||||
* Plugin URI: https://www.wpallstars.com
|
||||
* Description: Adds missing plugins to your plugins list with a "Remove Notice" action link, allowing you to safely clean up invalid plugin references.
|
||||
* Version: 2.2.5
|
||||
* Version: 2.3.0
|
||||
* Author: Marcus Quinn & The WPALLSTARS Team
|
||||
* Author URI: https://www.wpallstars.com
|
||||
* License: GPL-2.0+
|
||||
@ -35,4 +35,5 @@ if (!defined('WPINC')) {
|
||||
require_once plugin_dir_path(__FILE__) . 'includes/plugin.php';
|
||||
|
||||
// Initialize the plugin
|
||||
new WPALLSTARS\FixPluginDoesNotExistNotices\Plugin(__FILE__, '2.2.5');
|
||||
// This is a test change for our new workflow
|
||||
new WPALLSTARS\FixPluginDoesNotExistNotices\Plugin(__FILE__, '2.3.0');
|
||||
|
Reference in New Issue
Block a user