dclause/hermes-five

Rationalize example naming and folder structure

Offen

#23 geöffnet am 15.06.2025

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Rust (1 Fork)auto 404
code qualitydocumentationgood first issue

Repository-Metriken

Stars
 (37 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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.

Contributor Guide

Research-Richtung
Überprüfe das aktuelle examples/ Verzeichnis, liste vorhandene Dateien und Ordner auf, schlage ein konsistentes Benennungsschema vor und aktualisiere die README Dateien entsprechend.
Tech Stack
rust
Domain
documentationdeveloper experience
Issue Type
Refactoring
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
85