1. Make sure you have all of your project files!

First off - check that all your project’s files are actually in the repository! This includes a full CAD assembly in .STEP format, your PCB source files, and your firmware! This ensures that other people will actually be able to replicate your project!

It should look something like this:

It’s really hard to tell the difference between all the different files!

2. Organize the different files!

Next, you should organize all your different files!

I recommend making 3 folders - one called “CAD”, one called “PCB”, and one called “firmware”

Drag and drop your files into their respective folders. Here’s an example of what they should look like!

same files, but organized this time around!

3. Make a Bill Of Materials!

The next step is to make a bill of materials (BOM)!

A bill of materials is a list of all the parts & materials needed to make your project! You should include any components, modules, and any other parts you may need.

You should store this in a csv (comma-separated value) format. It’s plain text and works across almost every platform.

You can make your own, or use this template here.

It may be tempting to skip this step, but it’ll make it much easier to order your parts later!

4. Write a README.md about your project!

A README.md file is what ties your project together! It should include a short description of your project (what it does, how it works, why you made it), and also screenshots of your project!

Here’s an example of what that looks like!

Make sure to include a screenshot of your PCB(s)/wiring diagram if applicable - it makes reviewing way easier for us and cuts down on time!

One snippet you can add to your project is this. It adds a PCB button to your README that opens your repository’s PCB!

[![View PCB on KiCanvas](https://hack.club/pcb-badge)](https://kicanvas.org/?repo=https://github.com/<OWNER>/<REPOSITORY>/tree/main/pcb)

5. Double check the requirements!

HOLD ON! Right before you actually submit, you should double check your project actually follows all the requirements! Make sure you tick off each of the following:

Your project is actually complete:

• It has a complete CAD assembly, with all components (including electronics)
• You have firmware present, even if it’s untested
• You have asked for feedback from other people about your design

Your GitHub repository contains all of your files:

• a BOM, in CSV format in the root directory, WITH LINKS
• the source files for your PCB, if you have one (.kicad_pro, .kicad_sch, gerbers.zip, etc)
• A .STEP file of your project’s 3D CAD model (and ideally the source design file format as well - .f3d, .FCStd, etc)
• ANY other files that are part of your project (firmware, libraries, references, etc)

if you’re missing a .STEP file with all of your electronics and CAD, your project will not be approved

Your README.md is actually finished and has:

• A short description of what your project is
• A couple sentences on why you made the project

Pictures of your project:

• A screenshot of a full 3D model with your project
• A screenshot of your PCB, if you have one
• A wiring diagram, if you’re doing any wiring that isn’t on a PCB
• A BOM in table format at the end of the README

And lastly, you do not have:

• AI Generated READMEs
• Work that is not your own / copied from tutorials
• missing firmware/software

We know it’s a lot! It’s really important that you go through each item to maximize the chances of your project getting approved.

6. Submit!

Once you’re done with your project, you’re ready to submit it!

If you just finished a design and are looking for funding, submit it for funding from your project page

you should get to this screen!

If you just finished your build and are looking for Stardust, just ship your project and it’ll get sent to the review queue!

You’ll get a flat payout of 5 stardust per hour, with options to get more later!