Commit Guidelines
We use Conventional Commits to maintain a clear and searchable commit history.
Commit Message Format
<type>[optional scope]: <description>
[optional body]
[optional footer(s)]
Types
feat:- A new featurefix:- A bug fixdocs:- Documentation changesstyle:- Code style changes (formatting, no logic changes)refactor:- Code refactoring without changing functionalityperf:- Performance improvementstest:- Adding or updating testschore:- Maintenance tasks, dependency updatesci:- CI/CD configuration changesbuild:- Build system or external dependency changes
Scopes (Optional)
Use scopes to indicate the area of change:
ros2:- ROS 2 packages and nodesdocker:- Docker configuration and toolingcontrol:- Control system componentsperception:- Perception system componentsteleop:- Teleoperation functionalitynav:- Navigation stack components
Examples
feat(control): add PID controller for motor speed regulation
fix(nav): resolve timeout issue in planner server subscription
docs: update README with new installation instructions
style(ros2): format Python code according to PEP 8
refactor(docker): simplify compose service configuration
chore: update dependencies to latest stable versions