dclause/hermes-five

Rationalize example naming and folder structure

Aperta

#23 aperta il 15 giu 2025

Vedi su GitHub
 (0 commenti) (0 reazioni) (0 assegnatari)Rust (1 fork)auto 404
code qualitydocumentationgood first issue

Metriche repository

Star
 (37 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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.

Guida contributor

Direzione di ricerca
Esamina la directory examples/ corrente, elenca i file e le cartelle esistenti, proponi uno schema di denominazione coerente e aggiorna i file README di conseguenza.
Tech stack
rust
Dominio
documentationdeveloper experience
Tipo issue
Refactoring
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85