For creating a standard template for commit messages, use the structure below:
<type>: <short summary>
<detailed description>
<additional notes, if any>
Where <type>
could be:
add
: for new features or filesimpl
: for implementations of existing featuresimprove
: for improvements or optimizationsfix
: for bug fixesrefactor
: for code refactoringdocs
: for documentation changestest
: for adding or modifying tests
Examples:
- Adding new functions:
add: Implement user authentication functions
- Create login() function
- Add logout() function
- Implement password hashing utility
These functions provide a secure way to manage user sessions.
- Implementing a feature:
impl: Complete user registration process
- Add form validation
- Implement email verification
- Create user profile upon successful registration
This completes the user onboarding flow as per issue #123.
- Improving existing functionality:
improve: Optimize database queries for user listing
- Add indexing to frequently queried columns
- Implement pagination for large result sets
- Cache common query results
These changes significantly reduce page load times for user listings.