Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -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:
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -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)
15 changes: 15 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -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?
12 changes: 12 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
## Description

Brief description of the changes.

## Related Issue

closes #

## Checklist

- [ ] Tested locally
- [ ] README updated (if needed)
14 changes: 14 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -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
36 changes: 36 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -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/
44 changes: 44 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -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.
88 changes: 88 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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! 🤖
Loading