Repo - productization "item list"

Offen
#2 0 Kommentare 0 Reaktionen 1 zugewiesene Person Auf GitHub ansehen

@FacioErgoSum arbeitet bereits daran.

Seit 27.5.2026.

Bewertung

Dieses Issue wurde noch nicht bewertet.

Beschreibung

General list of items needed before the repo is published:

  • Add readme file - see this repo for an example - note this example is much longer that is normally expected for our sensors!
    • Include sheilds/badges in the readme (see example)
  • Add license file (MIT) - see this repo](https://github.com/sparkfun/SparkFun_FPC2534_Arduino_Library)
  • Enable doxygen generated documentation and publish to github pages (see the above example, talk with @gigapod ). This will include adding a deployment action/workflow.
  • Setup repo and documentation so it's included on our docs landing page (docs.sparkfun.com) - instructions for this are listed in the readme here
  • Complete setup for publishing the Arduino library (keywords.txt, library.json, library.properites) see this repo for an example
  • Add workflow to perform a cross compile check good example here
  • Right before launch on sparkfun.com, make repo public and publish the library to the Arduino library index. See https://github.com/arduino/library-registry
Vorherrschende Sprache
C++
Sterne
1
Forks
0
Ø Merge
1 Min.
Gemergte PRs (30 T.)
1

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus sparkfun/SparkFun_ADE7953_Arduino_Library

Alle Issues in sparkfun/SparkFun_ADE7953_Arduino_Library

Ähnliche Issues

Weitere Issues zu C++

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.