-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathCONTRIBUTING
42 lines (26 loc) · 1.82 KB
/
CONTRIBUTING
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
# Contributing to Project Name
Thank you for considering contributing to our project! Here are some guidelines to help you get started.
## Code of Conduct
Please note that this project is governed by our [Code of Conduct](CODE_OF_CONDUCT.md). Please review it before contributing.
## Getting Started
To start contributing, follow these steps:
1. Fork the repository on GitHub.
2. Clone your forked repository to your local machine.
3. Create a new branch for your contribution: `git checkout -b feature/my-feature`.
4. Make your changes and commit them: `git commit -m "Add new feature"`.
5. Push your changes to your forked repository: `git push origin feature/my-feature`.
6. Open a pull request on GitHub.
## Reporting Issues
If you encounter any issues with the project, please [open an issue](https://github.com/rwth-irt/IMU-Simulator/issues) on GitLab and provide as much detail as possible.
## Code Style
Follow the existing code style and conventions of the project.
Please follow these code style and conventions:
- [Google C++ Style Guide](https://google.github.io/styleguide/cppguide.html)
- [ROS 2 Code Style Guide](http://docs.ros.org/en/humble/The-ROS2-Project/Contributing/Code-Style-Language-Versions.html)
- [ROS 2 Developer Guide](https://docs.ros.org/en/rolling/The-ROS2-Project/Contributing/Developer-Guide.html#package-layout)
Make sure your code is well-formatted and documented. Please use [Doxygen](https://www.doxygen.nl/) for commenting.
## Testing
Make sure your code is well-tested. Please use [GoogleTest](http://google.github.io/googletest/) for the core functionalities.
Before submitting a pull request, make sure all tests pass and add new tests for any new functionality or changes.
## Licensing
By contributing to this project, you agree to license your contributions under the [LICENSE](LICENSE) of the project.