Repository navigation
CONTRIBUTING.md: how to report a device, record a USB capture and open a pull request - #114
Merged
Merged
Conversation
The README links it from Troubleshooting. The supported devices table is not changed here; that is HeyOkay#90. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01QmGsnjgXs8VbKmmxLkPsf6
The menu screenshots are the real Fluent menu of main, dark and light, over a plain backdrop; the reader's GitHub theme picks one. The capture steps link USBPcap's illustrated guide. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01QmGsnjgXs8VbKmmxLkPsf6
This was referenced Sep 28, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR adds
CONTRIBUTING.md, a short guide for people who want a device supported or want to add one. The README links to it from Troubleshooting.Base and other PRs
mainate80dfd1.CONTRIBUTING.md(new),docs/contributing/diagnostics-menu-dark.pngand-light.png(new, 38 KB and 43 KB),README.md(one sentence in Troubleshooting step 3).docs/protocols.mdfor the per-device detail #90: this PR does not change the supported devices table. Moving the table is the subject of README is getting long: a shorter support table and adocs/protocols.mdfor the per-device detail #90 (@casparas123), so this PR does not do it again. The two changes do not overlap: README is getting long: a shorter support table and adocs/protocols.mdfor the per-device detail #90 can link toCONTRIBUTING.mdfrom the new, shorter README.mainin five files (inREADME.md, the Preferences list); the sentence that this PR adds is in Troubleshooting and does not add a conflict.Why
Many device requests arrive without diagnostics, with a part of the diagnostics only, or with a USB capture that does not contain the maker's app traffic (#74 needed two retakes). The same instructions are written again in each issue. GitHub shows a link to
CONTRIBUTING.mdwhen a person opens an issue or a pull request, so the instructions are in one place.What the guide contains
main, in the dark and the light theme; a<picture>element shows the one that agrees with the reader's GitHub theme.--probe, with the unit id removed), and where the file is (%APPDATA%\HaloBattery\diagnostics.txt).main, use the provider of the protocol family, register a new provider, name the source of every command, add tests with fake HID devices, updateCHANGELOG.mdand the table, and write the source, the hardware test and the related PRs in the description.The guide uses short sentences and numbered steps, so that people who do not speak English as a first language can follow it.
Test
../../issues/newgoes to the issue form, the same pattern that the README uses for../../releases/latest.probe.batagree withhalo_battery.pywonmain.