Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
44 lines (28 loc) · 1.51 KB

CONTRIBUTING.md

File metadata and controls

44 lines (28 loc) · 1.51 KB
Raw

Contributing

Branching Strategy

This repository follows the GitFlow Workflow. If you're not familiar with it, please take a moment to review the basics.

Think Before You Fork

Before creating a fork, please open an issue on the GitHub page. That gives maintainers an opportunity to:

  • Confirm the bug or feature isn’t already in development
  • Share helpful context or existing work
  • Ensure alignment on goals and design

Avoid forking for changes that alter existing behavior without prior discussion.

Fixing a Bug in Production Code

To fix a bug, create a branch from master. This branch should be named using the format: hotfix/x.y.z-description

Where x.y.z follows Semantic Versioning.

Once complete, submit a pull request (PR) to master. A maintainer will review and merge the change.

Adding a Feature

To add a new feature, branch from devel.

Once your work is complete and tested, open a PR to devel. If accepted, your contribution will be included in the next stable release from master.

Additional Guidelines

  • Include or update documentation (Doxygen/README/etc.) as appropriate
  • Keep commits focused and meaningful (squash if needed before PR)
  • Ensure colcon build passes with no errors or warnings
  • Ensure ament_cpplint passes with no errors using a line length of 120, e.g. ament_cpplint <src_folder> --linelength 120

Thank you for helping make this project better! 🛰️