dclause/hermes-five

Rationalize example naming and folder structure

Aberta

#23 aberto em 15 de jun. de 2025

Ver no GitHub
 (0 comentário) (0 reação) (0 responsável)Rust (1 fork)auto 404
code qualitydocumentationgood first issue

Métricas do repositório

Stars
 (37 estrelas)
Métricas de merge de PR
 (Métricas PR pendentes)

Description

Motivation: Current example files and folder structure may be inconsistent or unclear, making it harder for users to discover and navigate them.

This task aims to review and improve:

  • Example file naming conventions
  • Folder organization within the examples/ directory

The goal is to improve usability and ease of discovery, especially for newcomers exploring features via examples.

Note:

  • Avoid naming example files after their corresponding src modules (e.g., led.rs, pca9685.rs) to improve file searchability in IDEs.
  • Update the example README file
  • Update the overall README file

Impact: No functional/API impact. This is a user / developer experience improvement.

Guia do colaborador

Direção de pesquisa
Revise o diretório examples/ atual, liste os arquivos e pastas existentes, proponha um esquema de nomenclatura consistente e atualize os arquivos README conforme necessário.
Pilha de tecnologia
rust
Domain
documentationdeveloper experience
Tipo Issue
Refatoração
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
1
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Menos de 1 hora
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Recente
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Git
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
85