Submission Requirements

In short, your repository needs to clearly show off what your project is whilst including your source files.

README.md should include:

  • A description of what your project is, and why you made it
  • Screenshots of your Final assembly (PCB + case if applicable), PCB, schematic, and anything else you'd like (e.g. a poster, banner, pinout diagram)
  • A Bill of Materials (BOM) with links, quantity, cost, and shipping. Even if you already own a part, include it!

Your repository should include:

PCB source files:

  • For KiCAD that includes at least .kicad_pro, .kicad_sch, .kicad_pcb, and .kicad_prl

Case source files:

Your project must have a complete CAD assembly, will all components (electronics included!)

  • Upload STEP Files (*.step) for each item you've modelled
  • Upload the source design file, the complete assembly (.f3d, FCStd, or a link to onshape)

Minimal firmware (if applicable):

  • If you are using a MCU, you likely need firmware. Learn to program our tutorial dongle here
  • The firmware doesn't need to be tested nor complete, but should be a starting point for future development

Finally, your project should be original, designed by you. Not an AI agent, nor someone else, just you. Your project should be unique! It shouldn't be a 1-to-1 copy of any guide, add your own twist on it!

//MANUFACTURER: HACK CLUB & SOPHIA
0x1234 Product ID:DONGLE-YSWS