Skip to content

added bom in readme requirement in docs #277

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
KOEGlike wants to merge 2 commits into
base: main
Choose a base branch
from
+1 −1
Open

added bom in readme requirement in docs #277

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8718a12
added bom in readme requirement in docs
KOEGlike Jun 20, 2026
16c3b2d
Update BOM requirement for clarity in submission
KOEGlike Jun 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/requirements/submitting-design.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ The design should also reasonably actually work\! Of course, you can’t be sure

#### Your GitHub repository needs to contain all your project files

- [x] A BOM (Bill of Materials) in CSV format, with links, and a line indicating the total cost\! Even if you own a part, still include it. Someone else needs to be able to build what you’ve designed
- [x] A BOM (Bill of Materials) in CSV format, with links, and a line indicating the total cost, this should also be added to your readme in a markdown table\! Even if you own a part, still include it. Someone else needs to be able to build what you’ve designed
- [x] The source files of your PCB, if you have one (`.kicad_pro`, `.kicad_sch`, `.kicad_pcb`, `.epro`, `gerbers.zip`, etc)
- [x] If you have 3D models, `.step` files of your project’s 3D CAD and the source design file (`.f3d`, `FCStd`, or a link to onshape)
- [x] Your firmware files, if applicable. Make sure to include the source code
Expand Down
Loading