Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
34 lines (22 loc) · 902 Bytes

CONTRIBUTING.md

File metadata and controls

34 lines (22 loc) · 902 Bytes

Contributing

Thank you for your interest in contributing to NeuroMesh!

Workflow

Branching

  • Branch from main for all new work.
  • Use descriptive branch names: feature/my-feature, fix/issue-description.

Development

  1. Install dependencies (see the Build guide).
  2. Make your changes with tests where applicable.
  3. Run colcon build --symlink-install and verify no regressions.

Pull Request

  1. Push your branch and open a PR against main.
  2. Summarize the changes, motivation, and any relevant test results.
  3. Assign at least one reviewer from the ARPL team.

Code Style

  • Follow ROS 2 C++ and Python style conventions.
  • Run ament_clang_format / ament_flake8 before committing.

Reporting Issues

Open a GitHub issue with:

  • A clear description of the bug or feature request.
  • Steps to reproduce (for bugs).
  • Expected vs. actual behaviour.