Skip to content

Commit ca4e0e3

Browse files
committed
chore: add GitHub repository metadata
- Add bug report and feature request issue templates - Add pull request template - Add Docker build CI workflow - Add CONTRIBUTING.md with development guidelines - Setup .github directory structure Enhances repository organization and contributor experience.
1 parent 68efb45 commit ca4e0e3

File tree

5 files changed

+398
-0
lines changed

5 files changed

+398
-0
lines changed
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: '[BUG] '
5+
labels: bug
6+
assignees: ''
7+
---
8+
9+
## Bug Description
10+
A clear and concise description of what the bug is.
11+
12+
## Environment
13+
- **Hardware**: Raspberry Pi model (e.g., Pi 5, Pi 4)
14+
- **OS**: Output of `uname -a`
15+
- **Docker version**: Output of `docker --version`
16+
- **Thread Radio**: SkyConnect / Other (specify)
17+
- **Matter Devices**: IKEA Alpstuga / Other (specify)
18+
19+
## Steps to Reproduce
20+
1.
21+
2.
22+
3.
23+
24+
## Expected Behavior
25+
What you expected to happen.
26+
27+
## Actual Behavior
28+
What actually happened.
29+
30+
## Logs
31+
```
32+
# Docker logs
33+
docker compose logs matter-mqtt-bridge
34+
35+
# OTBR status
36+
docker exec otbr ot-ctl state
37+
38+
# IPv6 configuration
39+
sysctl net.ipv6.conf.all.forwarding
40+
```
41+
42+
## MQTT Topics
43+
```
44+
# Output from mosquitto_sub if relevant
45+
mosquitto_sub -t 'matter/#' -v
46+
```
47+
48+
## Additional Context
49+
Add any other context about the problem here (screenshots, configuration files, etc.).
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: '[FEATURE] '
5+
labels: enhancement
6+
assignees: ''
7+
---
8+
9+
## Feature Description
10+
A clear and concise description of the feature you'd like to see.
11+
12+
## Use Case
13+
Explain the problem this feature would solve or the workflow it would improve.
14+
15+
## Proposed Solution
16+
Describe how you envision this feature working.
17+
18+
## Alternatives Considered
19+
Have you considered any alternative solutions or features?
20+
21+
## Additional Context
22+
Add any other context, mockups, or examples about the feature request here.
23+
24+
## Implementation Ideas
25+
If you have thoughts on how this could be implemented, share them here.

.github/pull_request_template.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
## Description
2+
Brief description of the changes in this PR.
3+
4+
## Type of Change
5+
- [ ] Bug fix (non-breaking change which fixes an issue)
6+
- [ ] New feature (non-breaking change which adds functionality)
7+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
8+
- [ ] Documentation update
9+
- [ ] Configuration change
10+
11+
## Changes Made
12+
-
13+
-
14+
-
15+
16+
## Testing
17+
Describe the tests you ran to verify your changes:
18+
- [ ] Tested on Raspberry Pi (specify model)
19+
- [ ] Verified OTBR status
20+
- [ ] Tested device commissioning
21+
- [ ] Verified MQTT topics
22+
- [ ] Checked Docker container health
23+
24+
## Checklist
25+
- [ ] My code follows the style of this project
26+
- [ ] I have updated the documentation where needed
27+
- [ ] I have tested my changes
28+
- [ ] All Docker services start successfully
29+
- [ ] MQTT topics work as expected
30+
- [ ] IPv6 configuration is maintained
31+
32+
## Screenshots (if applicable)
33+
Add screenshots to demonstrate the changes.
34+
35+
## Related Issues
36+
Closes #(issue number)

.github/workflows/docker-build.yml

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
name: Docker Build Test
2+
3+
on:
4+
push:
5+
branches: [ main ]
6+
pull_request:
7+
branches: [ main ]
8+
9+
jobs:
10+
build:
11+
runs-on: ubuntu-latest
12+
13+
steps:
14+
- name: Checkout code
15+
uses: actions/checkout@v4
16+
17+
- name: Set up Docker Buildx
18+
uses: docker/setup-buildx-action@v3
19+
20+
- name: Build Matter-MQTT Bridge
21+
uses: docker/build-push-action@v5
22+
with:
23+
context: ./bridge
24+
file: ./bridge/Dockerfile.bridge-v2
25+
push: false
26+
tags: matter-mqtt-bridge:test
27+
cache-from: type=gha
28+
cache-to: type=gha,mode=max
29+
30+
- name: Test Docker Compose syntax
31+
run: |
32+
docker compose -f docker-compose.yml config
33+
34+
- name: Verify required files
35+
run: |
36+
test -f setup.sh
37+
test -f README.md
38+
test -f bridge/matter_mqtt_bridge_v2.py
39+
test -f config/60-otbr-ipv6.conf
40+
test -f scripts/setup-ipv6.sh
41+
echo "✅ All required files present"

0 commit comments

Comments
 (0)