Best Practices for Commit Tags
Using Wemp tags effectively in your commit messages is key to getting the most out of automatic task tracking. This guide covers best practices for organizing your work and maintaining clean, trackable commit history.
Understanding Wemp Tags
Wemp recognizes three primary tags: @feature, @bugfix, and @refactor.
Each tag automatically categorizes your work and creates appropriate tasks in your project dashboard.
When to Use Each Tag
@feature
Use for new functionality, enhancements, or additions to your project. Examples:
• "Add user login @feature"
• "Implement payment gateway @feature"
@bugfix
Use for fixing bugs, errors, or issues. Examples:
• "Fix memory leak in API @bugfix"
• "Resolve authentication timeout @bugfix"
@refactor
Use for code improvements, restructuring, or optimization without changing functionality. Examples:
• "Refactor database queries @refactor"
• "Optimize component structure @refactor"
Writing Effective Commit Messages
A good commit message with a Wemp tag should be:
• Clear and descriptive: Explain what the commit does • Tagged appropriately: Use the correct tag for the work type • Concise: Keep it brief but informative
Common Patterns
✅ Good: "Add email validation @feature" ✅ Good: "Fix null pointer exception in user service @bugfix" ✅ Good: "Refactor API endpoints for better performance @refactor"
Tips for Teams
When working in a team, establish consistent tagging conventions:
• Agree on tag usage across the team • Use tags consistently in all commits • Review commit messages in code reviews