Repo - productization "item list"

Open
#2 0 comments 0 reactions 1 assignee View on GitHub

@FacioErgoSum is already working on this.

Since May 27, 2026.

Assessment

This issue has not been assessed yet.

Description

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
Dominant language
C++
Stars
1
Forks
0
Avg merge
1m
Merged PRs (30d)
1

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from sparkfun/SparkFun_ADE7953_Arduino_Library

All issues in sparkfun/SparkFun_ADE7953_Arduino_Library

Similar issues

More C++ issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.