WARNING: THIS SITE IS A MIRROR OF GITHUB.COM / IT CANNOT LOGIN OR REGISTER ACCOUNTS / THE CONTENTS ARE PROVIDED AS-IS / THIS SITE ASSUMES NO RESPONSIBILITY FOR ANY DISPLAYED CONTENT OR LINKS / IF YOU FOUND SOMETHING MAY NOT GOOD FOR EVERYONE, CONTACT ADMIN AT ilovescratch@foxmail.com
Skip to content

Commit 73079d6

Browse files
authored
Create ISSUE_TEMPLATE.md
1 parent 799af7d commit 73079d6

File tree

1 file changed

+41
-0
lines changed

1 file changed

+41
-0
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
Before filing an issue, please keep in mind that developer time is extremely limited.
2+
We are happy that you are excited to use this project :) but we do not have the time or
3+
resources to help users with their programming or debugging questions.
4+
Please read all of this before you delete it and type your bug if it is still appropriate.
5+
For reference over 90% of the issues that were mass closed in 2025/11 did not qualify as bugs,
6+
please help us help you by leaving more time for development.
7+
8+
If you have a problem, make sure that
9+
1) you read the entire top level README
10+
2) look at all the sub-pages: https://github.com/hzeller/rpi-rgb-led-matrix?tab=readme-ov-file#sub-pages
11+
3) if you are using example code, you should be able to read and understand that code
12+
13+
If you need further help, you can ask on discourse:
14+
https://rpi-rgb-led-matrix.discourse.group/
15+
Please understand again that no one is getting paid to help you. Help us help you:
16+
- say what you have
17+
- say what you tried
18+
- if your panel isn't working, you need to read the markings on the chips
19+
- search discourse and the bug tracker for your chip type if it's a chip issue or your issue type
20+
("half my lines are black").
21+
- generally please treat people's time as more valuable than yours, do as much as you can. There are
22+
many of you and only one of them :)
23+
24+
For panel support issues, you want to refer to https://github.com/hzeller/rpi-rgb-led-matrix/blob/master/README.md#panels-supported .
25+
The bugs working on chip support are for development, not "I bought this panel and I want you to make it work"
26+
(it is on you to research which panels are supported before you buy).
27+
If you have a commercial application where you need support for a new panel and are willing to pay
28+
consulting rates for that work, then it is ok to state so in the panel support bug and someone may
29+
be able to work something out with you, but again be mindful this is not a commercial or paid project.
30+
31+
A few master bugs that may help:
32+
- Pi5 support: https://github.com/hzeller/rpi-rgb-led-matrix/issues/1603
33+
- PWM panel support: https://github.com/hzeller/rpi-rgb-led-matrix/issues/466
34+
- HUB320: https://github.com/hzeller/rpi-rgb-led-matrix/issues/1618
35+
- Python bindings: https://github.com/hzeller/rpi-rgb-led-matrix/issues/1749
36+
- C# bindings: https://github.com/hzeller/rpi-rgb-led-matrix/issues/1828
37+
38+
For language bindings, note that the main developers are not using them, so they will lag. Your
39+
patience is appreciated, and help is welcome :)
40+
41+
Once you have read all this, if you still have a bug to file, you can delete this text and go ahead.

0 commit comments

Comments
 (0)