kicad-schlib icon indicating copy to clipboard operation
kicad-schlib copied to clipboard

Checks/tasks required before "release"

Open alexisvl opened this issue 8 years ago • 2 comments

This is a "living library", so there are no true releases, but I'd like to concentrate on some cleanup tasks that need to be performed to get it into a "release ready" status. Once this is done I may evangelize a bit more for this library :)

This issue is to collect a list of such tasks. So far:

  • Simple tasks:

    • Standard field size: all must be 50 mil
    • Field placement cleanup: arrange even hidden fields neatly so they're readable in libedit
    • Pin size: meet the requirements in DESIGN.md
    • All parts have description field as specified in DESCR.md
    • No single-footprint parts use filter list. Multiple-footprint parts can (e.g. new logic library, new conn library)
    • Datasheet field is populated
    • No parts use Keywords or Documentation File Name, these are deprecated
  • Specific library cleanup tasks:

    • ~~Check SWDIO/SWCLK on all ATSAMD* parts. Make sure these functions are assigned to the correct pins, and make sure SWDIO is positioned above SWCLK on the symbol to match CONN-CORTEX-DEBUG. This was a problem with these parts in the past and I'm not 100% sure it's totally fixed.~~ Done: d95247fc3e650c32cf5b73095722db1b59532afc
    • ~~Check voltage regulator pin types. In particular, some three-terminal regulators have ADJ set to Power Output (a vestige from this having been a GND pin that was edited). This should be Passive. See #2~~ Done: c08042e264a92403b16990796e75960e31812e5a
  • Large library cleanups. A separate issue will be created for each of these

    • Finish logic library rewrite. See #8
    • Start and finish connector library rewrite. See #9
    • Power library rewrite. See #10
    • Passive symbol type cleanup - IEC vs ANSI, etc. See #11
  • Policy to-do:

    • Standardize styling of microcontrollers. #13
    • Write contributor guide
      • Should we have a script set to automatically validate guidelines? Can we borrow the one from kicad/kicad-library ?
    • Come up with new guidelines for BOM / Manuf / MPN fields. bomtool is being deprecated. See #12

alexisvl avatar Jan 29 '17 14:01 alexisvl

As some of the new libraries are going to use the footprint filter list, I've created an issue in KiCad's tracker for making that a bit more usable in the new footprint field-based workflow:

Wish: use fp filter list in footprint selector

I'll probably implement that myself if nobody else does. I'm not sure how much code this single-part footprint selector shares with cvpcb, it may be easy or difficult to include this existing cvpcb functionality in it.

alexisvl avatar Jan 29 '17 14:01 alexisvl

First priority now is to run through the first section (simple tasks) one library at a time; I am doing this now.

alexisvl avatar Jan 30 '17 20:01 alexisvl