Hardware Git Nutzung

  • gearbeitet wird an den Dateien ohne Versionsnummer
  • diese werden immer fortschreibend committed
  • alles wird verwaltet in einem Repository - kein verschieben zwischen mehreren Repos
  • Ordner und Dateinamen folgen der Namenskonvention
  • Vergabe von Tags ist erwünscht
    • z.B. um erreichte Meilensteine zu markieren
    • macht insb. Sinn, wenn Test-PCBs geordert werden
  • Neue Releases werden gebildet indem
    • ein neuer Ordner mit der entsprechenden angehängten Versionsnummer gebildet wird
    • ein passender Tag vergeben wird
  • alle für dieses Release nötigen Dateien werden in den Ordner gespeichert (brd, sch, ibom, stl, ...)
  • möglichst ein Commit für eine Komponente (Ausnahme z.B.: in allen Schaltungen wurde dasselbe verändert)  
  • lieber mehrere, kleinteilige Commits statt wenige große (unübersichtliche) Commits
  • zumindest einen kurzen Kommentar, was denn geändert wurde
  • für experimentelle Weiterentwicklung wird empfohlen einen eigenen Branch zu machen; dieser sollte sich aber möglichst nur auf eine HW-Komponente beziegen
selfbus hw file versioning scheme

 Hardware Design / Naming

  • Kondensatoren und Spulen immer mit "nF", "uF", "mH" statt nur mit "n", "u", etc versehen
  • statt "µ" "u" verwenden - das erleichtert die automatische Suche
  • Standardbauteilgröße: 0805 bzw SOD-123
    • größere Bauteile nur in Ausnahmefällen (z.B. wg. Verfügbarkeit)
    • kleinere Bauteile sollten vermieden werden, außer die HW kann ohnehin nicht oder nur sehr schwer selbst gelötet werden 

Allgemeines

  • alle Dateien sollten (auch) in einem bearbeitbaren Format bereitgestellt werden (also pptx, f3d, etc. statt nur pdf, stl, etc.)
  • spätestens beim Releasen einer neuen HW-Version sollten mindestens bereitgestellt werden: Board, Schematic, iBom und Bom (als csv)