Skip to content

Commit a7fcffa

Browse files
bburdabburda
committed
Initial repo setup
1 parent 9321f09 commit a7fcffa

File tree

12 files changed

+598
-1
lines changed

12 files changed

+598
-1
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
name: Bug report
3+
about: Report a bug
4+
title: ""
5+
labels: bug
6+
assignees: ''
7+
---
8+
9+
## Description
10+
11+
A clear description of the bug.
12+
13+
## Steps to Reproduce
14+
15+
1.
16+
2.
17+
3.
18+
19+
## Expected vs Actual Behavior
20+
21+
What you expected vs what actually happened.
22+
23+
## Environment
24+
25+
- OS:
26+
- ROS 2 Distro:

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: ros2_medkit Documentation
4+
url: https://selfpatch.github.io/ros2_medkit/
5+
about: Check the ros2_medkit documentation for usage guidance
6+
- name: ros2_medkit Issues
7+
url: https://github.com/selfpatch/ros2_medkit/issues
8+
about: For issues with ros2_medkit itself (not the demos)

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
name: Feature request
3+
about: Suggest a feature or new demo
4+
title: ""
5+
labels: enhancement
6+
assignees: ''
7+
---
8+
9+
## Summary
10+
11+
Describe the feature or demo you'd like to see.
12+
13+
## Motivation
14+
15+
Why is this valuable?

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
## Description
2+
3+
Brief description of the changes.
4+
5+
## Related Issue
6+
7+
closes #
8+
9+
## Checklist
10+
11+
- [ ] Tested locally
12+
- [ ] README updated (if needed)

‎.github/workflows/ci.yml‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
name: CI
2+
3+
on:
4+
pull_request:
5+
branches: [main]
6+
push:
7+
branches: [main]
8+
9+
jobs:
10+
lint:
11+
runs-on: ubuntu-24.04
12+
steps:
13+
- name: Checkout repository
14+
uses: actions/checkout@v4

‎.gitignore‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# ROS 2 build artifacts
2+
build/
3+
install/
4+
log/
5+
6+
# Python
7+
__pycache__/
8+
*.py[cod]
9+
*$py.class
10+
*.egg-info/
11+
.eggs/
12+
dist/
13+
*.egg
14+
15+
# IDE
16+
.vscode/
17+
.idea/
18+
*.swp
19+
*.swo
20+
*~
21+
22+
# OS
23+
.DS_Store
24+
Thumbs.db
25+
26+
# Colcon
27+
COLCON_IGNORE
28+
29+
# Coverage
30+
.coverage
31+
htmlcov/
32+
33+
# Environment
34+
.env
35+
.venv/
36+
venv/

‎CODE_OF_CONDUCT.md‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Code of Conduct
2+
3+
## Our Pledge
4+
5+
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.
6+
7+
## Our Standards
8+
9+
Examples of behavior that contributes to creating a positive environment include:
10+
11+
- Being respectful and considerate in all communication
12+
- Using welcoming and inclusive language
13+
- Being open to different perspectives and experiences
14+
- Gracefully accepting constructive criticism
15+
- Focusing on what is best for the community
16+
- Showing empathy towards other community members
17+
18+
Examples of unacceptable behavior include:
19+
20+
- Harassment, discrimination, or abusive language
21+
- Trolling, insulting/derogatory comments, and personal or political attacks
22+
- Public or private harassment
23+
- Publishing others' private information without explicit permission
24+
- Other conduct which could reasonably be considered inappropriate in a professional setting
25+
26+
## Enforcement
27+
28+
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.
29+
30+
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.
31+
32+
## Reporting
33+
34+
If you experience or witness unacceptable behavior, please report it by:
35+
36+
- Using GitHub's "Report abuse" feature on the repository
37+
- Contacting the project maintainers via the repository's security contact listed in `SECURITY.md`
38+
- Opening a confidential issue if you feel comfortable doing so
39+
40+
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.
41+
42+
## Attribution
43+
44+
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.

‎CONTRIBUTING.md‎

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
# Contributing to selfpatch_demos
2+
3+
Thanks for your interest in contributing to selfpatch_demos! This guide explains how to report issues, suggest demos, and contribute code.
4+
5+
## How to Report Issues
6+
7+
### Did you find a bug in a demo?
8+
9+
- **Ensure the bug was not already reported** by searching [Issues](https://github.com/selfpatch/selfpatch_demos/issues)
10+
- If you can't find an existing issue, [open a new one](https://github.com/selfpatch/selfpatch_demos/issues/new)
11+
- Include:
12+
- **Which demo** you were running
13+
- **Steps to reproduce** - numbered steps to recreate the issue
14+
- **Expected behavior** - what you expected to happen
15+
- **Actual behavior** - what actually happened, including error messages
16+
- **Environment** - ROS 2 distro, OS, ros2_medkit version
17+
18+
### Do you want to suggest a new demo or improvement?
19+
20+
- Check if the idea has already been suggested in [Issues](https://github.com/selfpatch/selfpatch_demos/issues)
21+
- If not, open a new issue describing:
22+
- **Demo concept** - what would the demo show?
23+
- **Motivation** - why is this demo valuable?
24+
- **Prerequisites** - what ROS 2 packages or hardware would be needed?
25+
26+
## How to Contribute Code
27+
28+
### Development Workflow
29+
30+
1. **Fork the repository** and clone your fork locally
31+
2. **Create a branch** from `main` with a descriptive name:
32+
- `demo/short-description` for new demos
33+
- `fix/short-description` for bug fixes
34+
- `docs/short-description` for documentation changes
35+
3. **Make your changes** following the project's structure
36+
4. **Test your changes** locally
37+
5. **Commit your changes** with clear, descriptive commit messages
38+
6. **Push your branch** to your fork
39+
7. **Open a Pull Request** against the `main` branch
40+
41+
### Commit Messages
42+
43+
- Use clear and descriptive commit messages
44+
- Start with a verb in imperative mood (e.g., "Add", "Fix", "Update", "Remove")
45+
- Keep the first line under 72 characters
46+
47+
Examples:
48+
```
49+
Add TurtleBot3 navigation demo
50+
51+
Fix launch file path in turtlebot3_integration
52+
53+
Update README with new prerequisites
54+
```
55+
56+
### Demo Structure
57+
58+
When adding a new demo, follow this structure:
59+
60+
```
61+
demos/your_demo_name/
62+
├── README.md # Setup instructions and demo description
63+
├── launch/ # ROS 2 launch files
64+
├── config/ # Configuration files
65+
└── src/ # Any custom nodes or scripts (if needed)
66+
```
67+
68+
### Pull Request Checklist
69+
70+
Before submitting your PR, ensure:
71+
72+
- [ ] Demo works with the latest ros2_medkit
73+
- [ ] README clearly explains prerequisites and how to run
74+
- [ ] All dependencies are documented
75+
- [ ] Code follows ROS 2 conventions
76+
- [ ] PR description explains what the demo shows
77+
78+
## Code of Conduct
79+
80+
By contributing to selfpatch_demos, you agree to abide by our [Code of Conduct](CODE_OF_CONDUCT.md).
81+
82+
## License
83+
84+
By contributing to selfpatch_demos, you agree that your contributions will be licensed under the Apache License 2.0.
85+
86+
---
87+
88+
Thank you for helping grow the selfpatch_demos collection! 🤖

0 commit comments

Comments
 (0)