chore(boilerplate): Initialize

This commit is contained in:
2025-09-03 09:40:11 +02:00
committed by Wessel Tip
parent 4c25561d5b
commit 913ef3f0ac
11 changed files with 31 additions and 109 deletions

View File

@@ -1,20 +1,20 @@
# Contributing
If you wish to contribute to {{project.name}}, feel free to fork the repository and submit a pull request.
{{project.linter}} is enforced to correct most typo's you make and keep the code style the same throughout the whole project,
so it would be much appreciated if you installed {{project.linter}} to your editor of choice
If you wish to contribute to InHolland ROS2, feel free to fork the repository and submit a pull request.
sonarqube is enforced to correct most typo's you make and keep the code style the same throughout the whole project,
so it would be much appreciated if you installed sonarqube to your editor of choice
## Prerequisites
The following prerequisites must be met before installing {{project.name}}:
{{setup.prerequisites}}
The following prerequisites must be met before installing InHolland ROS2:
## Setup
To get ready to work on the codebase, please do the following:
1. Fork & clone the repository, and make sure you are on the **master** branch
2. Run {{setup.install}}
3. Code your ideas and test them using {{setup.test}}
4. [Submit a pull request](https://github.com/{{project.master}}/{{project.name}}/compare)
2. Run
3. Code your ideas and test them using
4. [Submit a pull request](https://github.com/wessel/InHolland ROS2/compare)
## Testing
When creating any new functions, please also create unit tests for them in the `tests` directory.