scottbez1/smartknob

Firmware Documentation

Open

#85 geöffnet am 13. Juli 2022

Auf GitHub ansehen
 (0 Kommentare) (3 Reaktionen) (0 zugewiesene Personen)C++ (1.262 Forks)batch import
documentationgood first issuetype: firmware

Repository-Metriken

Stars
 (21.794 Stars)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

I'm a hardware guy through and through, so the flashing portion of this project has been a complete mystery to me. I have PlatformIO setup (I think?), but I'm still lost on why attempts fail. Is there a chance the flashing process can be documented soon, at least on a basic level?

Contributor Guide

Research-Richtung
Untersuche das Firmware Verzeichnis des Repositorys und vorhandene Dokumentation. Sieh dir die PlatformIO Konfigurationsdatei (platformio.ini) an, um den Build und Flash Prozess zu verstehen. Teste das Flashing Verfahren mit einem Smartknob Gerät und erstelle eine Schritt für Schritt Anleitung. Verweise auf verknüpfte PRs oder Kommentare, falls verfügbar, obwohl derzeit keine existieren.
Tech Stack
cpp
Domain
Keine
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
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.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
PlatformIOGit
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80