AWViz-ROS C++ API Reference
|
Thank you for your interest in contributing to awviz-ros
🚀
We appreciate your effort to help improve this project. Please follow the guidelines below to ensure a smooth collaboration.
If you encounter any bugs, have feature requests, or want to ask questions, please open an issue.
When reporting an issue, please include:
We welcome pull requests (PRs) to address issues, improve documentation, or add new features.
Here's the process:
Fork the repository and clone your fork:
To ensure changes align with the existing code style, use pre-commit.
For the installation, please refer to the official document.
Before to start making your changes, please run the following command to set up pre-commit
hooks:
Now, pre-commit
will run automatically on git commit
!
Create a new branch for your contribution:
Commit your changes with clear adn descriptive commit messages:
Note that, we basically follow the Conventional Commits.
Push your branch to your fork:
To maintain a clean and consistent codebase, please follow these guidelines:
snake_case
for function names. For example, void set_name(const std::string & name);
.Before submitting a pull request, ensure that all tests pass successfully. You can run the tests using:
If you introduce a new feature or fix a bug, please add appropriate tests to cover the changes.
Well-written documentation is crucial for both users and developers. If your contribution affects the behavior of the system, please ensure that:
By contributing to awviz-ros
, you agree that your contributions will be licensed under the project's Apache-2.0.
If you have any questions, feel free to reach out by opening an issue. We're happy to assist!