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
|
||||
|
Reference in New Issue
Block a user