From a7fcffab0824274a0c4ea84fe22730fa2da81b6b Mon Sep 17 00:00:00 2001 From: Bartosz Burda Date: Wed, 26 Nov 2025 19:56:36 +0000 Subject: [PATCH] Initial repo setup --- .github/ISSUE_TEMPLATE/bug_report.md | 26 +++ .github/ISSUE_TEMPLATE/config.yml | 8 + .github/ISSUE_TEMPLATE/feature_request.md | 15 ++ .github/PULL_REQUEST_TEMPLATE.md | 12 ++ .github/workflows/ci.yml | 14 ++ .gitignore | 36 ++++ CODE_OF_CONDUCT.md | 44 +++++ CONTRIBUTING.md | 88 ++++++++++ LICENSE | 201 ++++++++++++++++++++++ README.md | 63 ++++++- SECURITY.md | 52 ++++++ demos/turtlebot3_integration/README.md | 40 +++++ 12 files changed, 598 insertions(+), 1 deletion(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 .github/workflows/ci.yml create mode 100644 .gitignore create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md create mode 100644 LICENSE create mode 100644 SECURITY.md create mode 100644 demos/turtlebot3_integration/README.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..629643b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,26 @@ +--- +name: Bug report +about: Report a bug +title: "" +labels: bug +assignees: '' +--- + +## Description + +A clear description of the bug. + +## Steps to Reproduce + +1. +2. +3. + +## Expected vs Actual Behavior + +What you expected vs what actually happened. + +## Environment + +- OS: +- ROS 2 Distro: diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..02bb581 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: true +contact_links: + - name: ros2_medkit Documentation + url: https://selfpatch.github.io/ros2_medkit/ + about: Check the ros2_medkit documentation for usage guidance + - name: ros2_medkit Issues + url: https://github.com/selfpatch/ros2_medkit/issues + about: For issues with ros2_medkit itself (not the demos) diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..5d47479 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,15 @@ +--- +name: Feature request +about: Suggest a feature or new demo +title: "" +labels: enhancement +assignees: '' +--- + +## Summary + +Describe the feature or demo you'd like to see. + +## Motivation + +Why is this valuable? diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..b6e05b2 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,12 @@ +## Description + +Brief description of the changes. + +## Related Issue + +closes # + +## Checklist + +- [ ] Tested locally +- [ ] README updated (if needed) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..8120b24 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,14 @@ +name: CI + +on: + pull_request: + branches: [main] + push: + branches: [main] + +jobs: + lint: + runs-on: ubuntu-24.04 + steps: + - name: Checkout repository + uses: actions/checkout@v4 diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..01e5dcc --- /dev/null +++ b/.gitignore @@ -0,0 +1,36 @@ +# ROS 2 build artifacts +build/ +install/ +log/ + +# Python +__pycache__/ +*.py[cod] +*$py.class +*.egg-info/ +.eggs/ +dist/ +*.egg + +# IDE +.vscode/ +.idea/ +*.swp +*.swo +*~ + +# OS +.DS_Store +Thumbs.db + +# Colcon +COLCON_IGNORE + +# Coverage +.coverage +htmlcov/ + +# Environment +.env +.venv/ +venv/ diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..b91d165 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,44 @@ +# Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment include: + +- Being respectful and considerate in all communication +- Using welcoming and inclusive language +- Being open to different perspectives and experiences +- Gracefully accepting constructive criticism +- Focusing on what is best for the community +- Showing empathy towards other community members + +Examples of unacceptable behavior include: + +- Harassment, discrimination, or abusive language +- Trolling, insulting/derogatory comments, and personal or political attacks +- Public or private harassment +- Publishing others' private information without explicit permission +- Other conduct which could reasonably be considered inappropriate in a professional setting + +## Enforcement + +Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. + +## Reporting + +If you experience or witness unacceptable behavior, please report it by: + +- Using GitHub's "Report abuse" feature on the repository +- Contacting the project maintainers via the repository's security contact listed in `SECURITY.md` +- Opening a confidential issue if you feel comfortable doing so + +All reports will be reviewed and investigated promptly and fairly. All project maintainers are obligated to respect the privacy and security of the reporter of any incident. + +## Attribution + +This Code of Conduct is adapted from the [GitHub Community Code of Conduct](https://docs.github.com/en/site-policy/github-terms/github-community-code-of-conduct) and the [Contributor Covenant](https://www.contributor-covenant.org/version/2/1/code_of_conduct/), version 2.1. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..cca7e8c --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,88 @@ +# Contributing to selfpatch_demos + +Thanks for your interest in contributing to selfpatch_demos! This guide explains how to report issues, suggest demos, and contribute code. + +## How to Report Issues + +### Did you find a bug in a demo? + +- **Ensure the bug was not already reported** by searching [Issues](https://github.com/selfpatch/selfpatch_demos/issues) +- If you can't find an existing issue, [open a new one](https://github.com/selfpatch/selfpatch_demos/issues/new) +- Include: + - **Which demo** you were running + - **Steps to reproduce** - numbered steps to recreate the issue + - **Expected behavior** - what you expected to happen + - **Actual behavior** - what actually happened, including error messages + - **Environment** - ROS 2 distro, OS, ros2_medkit version + +### Do you want to suggest a new demo or improvement? + +- Check if the idea has already been suggested in [Issues](https://github.com/selfpatch/selfpatch_demos/issues) +- If not, open a new issue describing: + - **Demo concept** - what would the demo show? + - **Motivation** - why is this demo valuable? + - **Prerequisites** - what ROS 2 packages or hardware would be needed? + +## How to Contribute Code + +### Development Workflow + +1. **Fork the repository** and clone your fork locally +2. **Create a branch** from `main` with a descriptive name: + - `demo/short-description` for new demos + - `fix/short-description` for bug fixes + - `docs/short-description` for documentation changes +3. **Make your changes** following the project's structure +4. **Test your changes** locally +5. **Commit your changes** with clear, descriptive commit messages +6. **Push your branch** to your fork +7. **Open a Pull Request** against the `main` branch + +### Commit Messages + +- Use clear and descriptive commit messages +- Start with a verb in imperative mood (e.g., "Add", "Fix", "Update", "Remove") +- Keep the first line under 72 characters + +Examples: +``` +Add TurtleBot3 navigation demo + +Fix launch file path in turtlebot3_integration + +Update README with new prerequisites +``` + +### Demo Structure + +When adding a new demo, follow this structure: + +``` +demos/your_demo_name/ +├── README.md # Setup instructions and demo description +├── launch/ # ROS 2 launch files +├── config/ # Configuration files +└── src/ # Any custom nodes or scripts (if needed) +``` + +### Pull Request Checklist + +Before submitting your PR, ensure: + +- [ ] Demo works with the latest ros2_medkit +- [ ] README clearly explains prerequisites and how to run +- [ ] All dependencies are documented +- [ ] Code follows ROS 2 conventions +- [ ] PR description explains what the demo shows + +## Code of Conduct + +By contributing to selfpatch_demos, you agree to abide by our [Code of Conduct](CODE_OF_CONDUCT.md). + +## License + +By contributing to selfpatch_demos, you agree that your contributions will be licensed under the Apache License 2.0. + +--- + +Thank you for helping grow the selfpatch_demos collection! 🤖 diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md index 417568a..1e19c68 100644 --- a/README.md +++ b/README.md @@ -1 +1,62 @@ -# selfpatch_demos \ No newline at end of file +# selfpatch_demos + +[![CI](https://github.com/selfpatch/selfpatch_demos/actions/workflows/ci.yml/badge.svg)](https://github.com/selfpatch/selfpatch_demos/actions/workflows/ci.yml) + +Demonstration projects showcasing [ros2_medkit](https://github.com/selfpatch/ros2_medkit) integration +with real ROS 2 systems. + +## Overview + +This repository contains example integrations and demos that show how ros2_medkit +can be used to add modern diagnostics to ROS 2-based robots and systems. + +Each demo builds on real-world scenarios, starting from basic integration and +progressing toward more advanced use cases. + +## Demos + +| Demo | Description | Status | +|------|-------------|--------| +| [TurtleBot3 Integration](demos/turtlebot3_integration/) | Basic ros2_medkit integration with TurtleBot3 and Nav2 | 🚧 In Progress | + +## Getting Started + +### Prerequisites + +- ROS 2 Jazzy (Ubuntu 24.04) +- [ros2_medkit](https://github.com/selfpatch/ros2_medkit) installed + +### Clone the Repository + +```bash +git clone https://github.com/selfpatch/selfpatch_demos.git +cd selfpatch_demos +``` + +### Run a Demo + +Each demo has its own README with specific instructions. Start with: + +```bash +cd demos/turtlebot3_integration +# Follow the README.md in that directory +``` + +## Related Projects + +- [ros2_medkit](https://github.com/selfpatch/ros2_medkit) — The core diagnostics library +- [ros2_medkit documentation](https://selfpatch.github.io/ros2_medkit/) — Full documentation and API reference + +## Contributing + +Contributions are welcome! Please read [`CONTRIBUTING.md`](CONTRIBUTING.md) for guidelines. + +By contributing, you agree to follow the [`CODE_OF_CONDUCT.md`](CODE_OF_CONDUCT.md). + +## Security + +If you discover a security vulnerability, please follow the process in [`SECURITY.md`](SECURITY.md). + +## License + +This project is licensed under the Apache License 2.0. See the [`LICENSE`](LICENSE) file for details. \ No newline at end of file diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..3c3334a --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,52 @@ +# Security Policy + +## Reporting Security Vulnerabilities + +Security vulnerabilities are taken seriously. I appreciate your efforts to responsibly disclose your findings and will make every effort to acknowledge your contributions. + +### How to Report a Security Vulnerability + +**Please do not report security vulnerabilities through public GitHub issues.** + +Instead, please report them using one of the following methods: + +1. **Preferred: GitHub Security Advisories** (recommended) + - Go to the [Security tab](https://github.com/selfpatch/selfpatch_demos/security/advisories/new) of this repository + - Click "Report a vulnerability" + - Fill out the form with details about the vulnerability + +2. **Alternative: Private email** + - If you cannot use GitHub's private reporting, contact the project maintainers via the contact email listed on the GitHub profile + +### What to Include in Your Report + +To help us understand and resolve the issue quickly, please include: + +- **Description** - A clear description of the vulnerability and its potential impact +- **Steps to Reproduce** - Detailed steps to reproduce the issue +- **Affected Demo** - Which demo is affected +- **Impact Assessment** - Your assessment of the severity and potential impact + +### What to Expect + +- **Acknowledgement** - I will acknowledge receipt of your report within 5 business days +- **Updates** - I will keep you informed about progress in addressing the vulnerability +- **Credit** - With your permission, you will be credited in any public disclosure + +## Supported Versions + +| Version | Supported | +| ------- | ------------------ | +| main | :white_check_mark: | + +## Security Notes for Demos + +The demos in this repository are intended for **development and learning purposes**. +When deploying ros2_medkit in production environments: + +- Follow ROS 2 security best practices +- Properly configure network access controls +- Review and audit diagnostic configurations +- See [ros2_medkit documentation](https://selfpatch.github.io/ros2_medkit/) for security guidance + +Thank you for helping keep selfpatch_demos and its users safe! diff --git a/demos/turtlebot3_integration/README.md b/demos/turtlebot3_integration/README.md new file mode 100644 index 0000000..13c0c7d --- /dev/null +++ b/demos/turtlebot3_integration/README.md @@ -0,0 +1,40 @@ +# TurtleBot3 Integration Demo + +This demo shows how to integrate ros2_medkit with TurtleBot3 and Nav2 to provide +modern diagnostics for a mobile robot navigation system. + +## Status + +🚧 **Work in Progress** + +## Overview + +This demo will demonstrate: + +- Discovering TurtleBot3 nodes through ros2_medkit REST API +- Organizing navigation components into diagnostic areas +- Reading sensor data and navigation state via HTTP +- Monitoring robot health during autonomous navigation + +## Prerequisites + +- ROS 2 Jazzy (Ubuntu 24.04) +- [ros2_medkit](https://github.com/selfpatch/ros2_medkit) +- TurtleBot3 packages +- Nav2 navigation stack + +## Installation + +*Coming soon* + +## Usage + +*Coming soon* + +## What You'll See + +*Coming soon* + +## Architecture + +*Coming soon*