Contributing to Cangaroo

January 4, 2026 ยท View on GitHub

Thank you for your interest in contributing to Cangaroo! We welcome contributions from engineers, developers, and enthusiasts.

How Can I Contribute?

Reporting Bugs

  • Check the Issues Tab to see if the bug has already been reported.
  • If not, create a new issue. Include as much detail as possible, such as:
    • Your OS and version.
    • The CAN hardware you are using.
    • Steps to reproduce the issue.
    • Any error logs or screenshots.

Suggesting Features

  • We love hearing new ideas! Please start a Discussion to talk about your feature request.

Submitting Pull Requests

  1. Fork the repository and create your branch from master.
  2. Ensure your code builds and follows the existing coding style (Qt/C++).
  3. Document your changes: Update the README or headers if necessary.
  4. Open a Pull Request: Provide a clear description of the problem you are solving or the feature you are adding.

Coding Standards

  • We use Qt 6 (targeted at v6.10+).
  • Prefer range-based for loops over foreach.
  • Keep memory safety in mind (use smart pointers where appropriate).

Community

Join the conversation in the GitHub Discussions.

By contributing, you agree that your contributions will be licensed under the project's GPL-3.0+ license.