Versiona o CI e alinha o CONTRIBUTING - #2
Merged
Merged
Conversation
O ci.yml existia so na minha maquina, nunca foi commitado. O badge no topo do README aponta pra actions/workflows/ci.yml, entao desde a publicacao ele renderiza quebrado — quem chega no repo ve imagem falhando na primeira linha. Acrescenta 3.13 a matriz: requires-python e >=3.10 e nada no codigo impede as versoes novas, entao vale exercitar as duas pontas do range. O que a CI cobre hoje: ruff e os testes de funcao pura (montagem de pacote, checksum, encoding RGB565, geometria). NAO cobre o device.py — enumeracao de PIDs e escolha do binding hidapi — que precisa de um modulo hid falso para testar sem hardware. Fica anotado como proximo passo, pra ninguem ler o badge verde como garantia de que a camada de dispositivo esta testada. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
O guia de contribuicao ficou pra tras em tres pontos, e quem chega de fora le ele antes de qualquer outra coisa. Ambiente de dev: so tinha Ubuntu (`sudo apt install libhidapi-hidraw0`), enquanto o README ja documenta Arch e Debian. Agora traz os dois, separa a regra udev (que e comum as distros) e inclui a armadilha dela so valer no proximo evento de conexao. Acrescenta o passo de rodar ruff e pytest antes de abrir PR, que e exatamente o que a CI vai cobrar. Reporte de modelo: pede tambem o modo de conexao. O mesmo teclado enumera com idProduct diferente no cabo e no dongle, entao um reporte sem essa informacao e ambiguo — e no Bluetooth nao ha canal vendor pra testar. Estilo: dizia "sem dependencias alem de hid", mas pillow e dependencia desde o set-gif. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
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
1 participant
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.
Duas correções de "casa em ordem", nenhuma toca o código do driver.
1. O workflow de CI nunca foi versionado
O
ci.ymlexistia só na minha máquina. O badge no topo do README aponta paraactions/workflows/ci.yml, então desde a publicação ele renderiza quebrado — quem chega no repo vê uma imagem falhando na primeira linha, o que passa impressão de abandono num projeto que está funcionando.Acrescenta
3.13à matriz: orequires-pythoné>=3.10e nada no código impede as versões novas, então vale exercitar as duas pontas do range.O que a CI cobre:
ruffe os testes de função pura — montagem de pacote, checksum, encoding RGB565 e geometria. O que ela não cobre: odevice.py(enumeração de PIDs e escolha do binding hidapi), que precisa de um módulohidfalso para testar sem hardware. Vale deixar isso explícito para ninguém ler o badge verde como garantia de que a camada de dispositivo está testada — ela é justamente a que quebrou no Arch e no dongle.2. O CONTRIBUTING ficou para trás
idProductdiferente no cabo e no dongle, então um reporte sem isso é ambíguo.hid", maspillowé dependência desde oset-gif.ruffepytestantes de abrir PR — o mesmo que a CI cobra.