From a051fa22079a330d2e7cab413d7f43e8b85703ec Mon Sep 17 00:00:00 2001 From: Rene Ebeling <rene.ebeling@alumni.fh-aachen.de> Date: Tue, 13 May 2025 09:13:36 +0200 Subject: [PATCH] Update subproject commit to indicate a dirty state; add CONTRIBUTING.md for contribution guidelines --- CONTRIBUTING.md | 47 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..3d78385 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,47 @@ +# Contributing to Robot Sensor + +Thank you for considering contributing to the Robot Sensor project! We welcome contributions of all kinds. Please follow the guidelines below to ensure a smooth collaboration. + +## How to Contribute + +1. **Fork the Repository** + Fork the repository to your GitHub account and clone it to your local machine. + +2. **Create a Branch** + Create a new branch for your feature or bug fix: + ```bash + git checkout -b feature/your-feature-name + ``` + +3. **Make Changes** + Implement your changes, ensuring your code adheres to the project's coding standards. + +4. **Write Tests** + Add or update tests to cover your changes. + + +6. **Commit Changes** + Write clear and concise commit messages: + ```bash + git commit -m "Add feature: your-feature-name" + ``` + +7. **Push Changes** + Push your branch to your forked repository: + ```bash + git push origin feature/your-feature-name + ``` + +8. **Submit a Pull Request** + Open a pull request to the main repository. Provide a detailed description of your changes. + + +## Reporting Issues + +If you encounter a bug or have a feature request, please open an issue in the repository. Provide as much detail as possible. + +## Contact + +If you have any questions, feel free to reach out by opening a discussion or contacting the maintainers. + +Thank you for contributing! \ No newline at end of file -- GitLab