Interested in submitting to OnBoard? You're in the right place!
1. Join #onboard on Slack!
Our #onboard channel is where the party is getting started! If you haven't already joined, make sure to add yourself to the channel. And for those who are new to the Hack Club slack, sign up to our community of 13k+ makers through here (don't worry, there isn't an application).
Perhaps ping a little hello to @Kevin Yang?
To follow the repo for updates and show you're participating, click the "star" button on the onboard repo.
Fork the onboard repo! This is the where you'll add your project files and eventually PR from!
It's design time! Head over to an eCAD software of your choice (EasyEDA, KiCAD, Eagle) and start designing!
Never designed before? No problem! We have design resources for EasyEDA, a free online eCAD program. We'll be adding tutorials to design_resources.md as we record them!
Upload your Gerber files to JLCPCB and add them to you cart. Once completed, take a screenshot with cost included!
If you're curious what all the settings are about or how to order for assembly, check out our
ordering_from_JLCPCB.mddoc!
Note: Your screenshot is VITAL since your project cannot be approved without it. You'll include the screenshot in your PR later.
From your fork of OnBoard, create a folder with your project name under OnBoard/projects. To do this, go to the projects folder and click Create new file.
Then in the box labeled name your file..., type in PROJECT_NAME/README.md. This creates a README file under a folder called named after your project.
After this, copy and paste the contents of TEMPLATE.md into the text editor and fill it out!
Once your done, press the big green Commit changes button to save!
With your README filled out, head over to add files to begin uploading your Gerber, design files, and screen shot of JLCPCB approval.
In all, you should have the following files under your project folder:
-
README.md: A filled outTEMPLATE.md, renamed toREADME.md -
JLCPCB.png: A screen shot of JLCPCB approving your board -
Gerbers.zip: This should be the file that you send off to JLCPCB. - Design files (
design.json,design.sch,design.brd, etc). Whatever format your designer outputs to should be included.
If you have all the above, you're done with this step!
Once you've uploaded your files, you can merge them to the main repo through a pull request! Under the contribute tab of your forked repo, click the big green Open pull request.
That will bring you to the main repo, where you'll initiate a pull request. Follow the checklist, we'll then review your PR and you'll be off to the races!
Here's a quick preview of the submission checklist
- I am a current high school, middle school, or home schooled student.
- I have followed DIRECTIONS.md
- Created a folder under
onboard/projects- Filled out
TEMPLATE.md- Uploaded Gerber and design files
- Uploaded screen shot of PCB passing JLCPCB inspection
Post photos of your board in #onboard! We can't wait to see what you make!
