Skip to content

Commit

Permalink
Repository cleanup and guideline refractoring (#856)
Browse files Browse the repository at this point in the history
* cleanup files

* add information for ordering with stencil & clarify checkout process

* Minor refraction and asking for .step files from KiCad

* Refractor

* Add another electronic youtuber resource

* change from 14 days to 7 days

* the trail is over :(

* change faq email from bank@hackclub.com
  • Loading branch information
LimesKey committed Jul 22, 2024
1 parent bc3f3eb commit b68062d
Show file tree
Hide file tree
Showing 15 changed files with 43 additions and 387 deletions.
1 change: 0 additions & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@
- [ ] If outside the US I've checked that I can afford the customs charges in my country (which isn't covered by the grant)

- [ ] (Optional) This project is from a tutorial[^1].
- [ ] (Optional) This project is for [the Trail](https://trail.hackclub.com/).
- [ ] (Optional) I'm in a FIRST (FRC, FTC, FLL, etc.) team. The number is: ____

[^1]: Projects from a tutorial are 100% fine! We just want to ask so we can count how people are using tutorials.
Expand Down
7 changes: 5 additions & 2 deletions .github/workflows/cleanup.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,16 +19,19 @@ jobs:
close-pr-message: >
This pull request has been inactive for some time and has therefore been closed. Feel free to create a new one when you're ready.
# The number of days old an issue or a pull request can be before marking it stale. Set to -1 to never mark issues or pull requests as stale automatically.
days-before-stale: 7
days-before-issue-stale: 30
days-before-pr-stale: 7
# The number of days to wait to close an issue or a pull request after it being marked stale. Set to -1 to never close stale issues or pull requests.
days-before-close: 14
days-before-close: 7
# The number of days to wait to close an issue after it being marked stale. Set to -1 to never close stale issues. Override "days-before-close" option regarding only the issues.
days-before-issue-close: -1
# The label to apply when an issue is stale.
stale-issue-label: "Stalled"
# The labels that mean an issue is exempt from being marked stale. Separate multiple labels with commas (eg. "label1,label2").
exempt-issue-labels: "Dev"
exempt-pr-labels: "Dev"
# The label to apply when a pull request is stale.
stale-pr-label: "Stalled"
# Only pull requests with at least one of these labels are checked if stale. Defaults to `` (disabled) and can be a comma-separated list of labels. Override "any-of-labels" option regarding only the pull requests.
any-of-pr-labels: Submission
include-only-assigned: true
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ _If you get stuck on these tutorials, or want more example projects to learn fro

### 3. Upload to a Vendor and Take a Screenshot

Upload your Gerber files to JLCPCB.com and add them to you cart. JLCPCB is the default PCB manufacturer, but you can shop around [^5] if there's a specific one you want to use [^6]. Once completed, take a screenshot with all the final costs and shipping!
Upload your Gerber files to [JLCPCB.com](https://jlcpcb.com/) and add them to you cart. JLCPCB is the default PCB manufacturer, but you can shop around [^5] if there's a specific one you want to use [^6]. Ensure you complete the checkout process by entering your address and selecting a shipping method. Once completed, take a screenshot with all the final costs and shipping!
> If you're curious what all the settings are about or how to order for assembly, check out our [`ordering_from_JLCPCB.md`](./docs/ordering_from_JLCPCB.md) doc!
> To avoid excess shipping fees or customs, check out [`the Shipping Tips`](./community/shipping.md) doc!
Expand Down Expand Up @@ -96,13 +96,13 @@ With your README filled out, head over to add files to begin uploading your Gerb

In all, you should have the following files under your project folder:
- [ ] `README.md`: A filled out [`TEMPLATE.md`](./projects/!Template/TEMPLATE.md?plain=1), renamed to `README.md`
- [ ] `cart.png`: A screenshot of your order details
- [ ] `cart.png`: A [screenshot](./docs/images/ordering/cart.png) of your order details
- [ ] `gerber.zip`: This should be the file that you send off to the vendor.
- [ ] `schematic.pdf`: Export the schematic from your EDA program as a PDF.
- Go to "File > Export > PDF" in EasyEDA's Schematic tab for this.
- [ ] `src/`: Make a folder called `src` and Whatever format your designer outputs should be included.
- For EasyEDA, you need to File > Export > EasyEDA two JSON files - one from the schematic tab and one from the PCB tab. <img src="https://github.com/hackclub/OnBoard/assets/32671690/9f63f922-3009-4c40-af0c-b6239cf2074f" width=500/>
- Or `name.kicad_pro`, `name_kicad_sch`, and `name.kicad_pcb` for KiCAD
- Or `name.kicad_pro`, `name_kicad_sch`, `name.kicad_pcb` and `name.step` for KiCAD
- Or `design.json`, `design.sch`, `design.brd`, etc.

Make sure your file names are exactly the same as above.
Expand All @@ -129,7 +129,7 @@ Once you submit your PR, it needs two approvals:
- One verifying your high school enrollment documents, from HCB.
- Another one from the engineering team, checking that your design follows the grant requirements.

These reviews typically take 24-48 business hours if everything is correct. Then we merge your PR!
These reviews typically take 24-48 business hours, and if everything is correct, we'll merge your pull request!

After your PR gets merged, it takes up to 24 business hours for you to receive an email from HCB with a virtual credit card. Make sure to check your spam folder. Then, you can order your board!

Expand All @@ -141,6 +141,6 @@ Post photos of your board in [`#electronics`](https://hackclub.slack.com/archive

## Example Projects

- [PCB Business Card with NFC](https://jams.hackclub.com/jam/hacker-card)
- [PCB Business Card with NFC, "Hackercard"](https://jams.hackclub.com/jam/hacker-card)
- [Build a USB Hub](https://jams.hackclub.com/batch/usb-hub)
- [Make a Digital Level](https://jams.hackclub.com/batch/sparkletilt-pcb)
9 changes: 5 additions & 4 deletions community/TIPS.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
# OnBoard Tips
# OnBoard Tips - By The Students

Here are a few tips to make your OnBoard experience as smooth as possible! A collection of tips from OnBoard participants!

Here are a few tips to make your OnBoard experience as smooth as possible!

---

1. When HQ gives you your credit card and you pay for your PCB, make sure to select a coupon at checkout! This way you will have more money to build more PCBs in the future.
1. When recieving your grant and you're ready to pay for your PCB, make sure to select a coupon at checkout! This way you will have more money to build more PCBs in the future.
2. Try to buy multiple designs at the same time to save on shipping!
3. Don't forget to submit your invoice/receipt to Hack Club bank after paying!!!!
4. Select the "assemble" option when ordering! This way everything will come assembled.
5. Use Lead-free HASL!
6. When ordering, you may get an alert that some parts "unselected". This can be ignored.
6. When ordering, you may get an alert that some parts "unselected". This usually can be ignored.
7. You can design as many boards as you want, as long as the total cost doesn't go over $100.
8. While generating your gerber files in EasyEDA, always chose the One-Click Order option to get a $8 discount. It's more efficient and hassle free, generating and submitting the BOM, Pick&Place, and Gerber files automatically. [More information ℹ️.](https://support.jlcpcb.com/article/217-special-offer-get-8-off-coupon-once-a-month-for-easyeda-project)
10 changes: 6 additions & 4 deletions community/shipping.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,17 @@
# Shipping Tips

How to minimize your PCB shipping costs so you can make the most out of your OnBoard grant.
If you have any general tips or info for your country, please let us know.
How to minimize your PCB shipping costs so you can make the most out of your OnBoard grant. If you have any general tips or info for your country, please create a issue and let us know.

## General

- Sometimes selecting a thinner PCB (going from 1.6mm to 1.0mm) can make shipping cheaper by reducing the board weight. Try different options and see if the cost increase of the PCB and decrease of shipping cancel out. Alternatively, some manufacturers charge extra for thicknesses other than 1.6mm - if your assembly is costing more than expected, this could be te reason.
- Choose the **"Global Direct Standard Line"** if available. While this shipping method is although rare to get, it can be very cost-effective and usually has no customs fees. One downside is that this shipping method is the slowest of them all and will often will take 2 weeks to arrive.

- Sometimes selecting a **thinner PCB** (going from 1.6mm to 1.0mm) can make shipping cheaper by reducing the board weight. Try different options and see if the cost increase of the PCB and decrease of shipping cancel out. Alternatively, some manufacturers charge extra for thicknesses other than 1.6mm - if your assembly is costing more than expected, this could be the reason.

- If your board allows it, removing or replacing heavy assembled components can help reduce shipping costs.

## United States

- From JLCPCB, use Global Direct Standard Line for the cheapest shipping, although it might take a week or two to arrive.
- For small boards, when you don't want assembly, OSHPark could be cheaper. Their boards are more expensive but shipping is free.

## India
Expand Down
15 changes: 0 additions & 15 deletions community/tips-by-the-students.md

This file was deleted.

1 change: 1 addition & 0 deletions docs/design_resources.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ Never designed a PCB before? You're in the right place! The OnBoard community ha
- GreatScott!:
- [Electronic Basics #14: Capacitors](https://www.youtube.com/watch?v=otQGdPLyF3w&list=PLAROrg3NQn7cyu01HpOv5BWo217XWBZu0&index=42)
- [Electronic Basics #16: Resistors](https://www.youtube.com/watch?v=7w5I-KbJ1Sg&list=PLAROrg3NQn7cyu01HpOv5BWo217XWBZu0&index=40)
- ElectroBOOM: [Electronics](https://youtube.com/playlist?list=PLr_CZLgMkHeXc_45uIgYutY0m6fqmI5du&si=WIVFAfIjkPKWoWJn)


## PCB Tutorials
Expand Down
9 changes: 6 additions & 3 deletions docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Yes, this event is open to everyone. However, this program was designed in North

##### Can multiple people team up to work on a project?

If you team up with an IRL friend and want to build a project together, you would work together to submit one pull request. All teammates must meet requirements for the event (eg. under 18, have submitted RSVP, be on Slack, etc.) The grant amount would be for up to $100 per person, growing with team size. You must be able to meet up in person to work on the project with your teammate(s). The maximum number of people in a team is 4.
If you team up with an IRL friend and want to build a project together, you would work together to submit one pull request. All teammates must meet requirements for the event (eg. under 18, have submitted RSVP, be on Slack, etc.) The grant amount would be for up to $100 per person, growing with team size. You must be able to meet up in person to work on the project with your teammate(s). The maximum number of people in a team is 4. Let the pull request reviewer know you're with a team and be ready to provide clarification on your team.

##### How many total grants are there available?

Expand All @@ -22,15 +22,15 @@ Yes! You can design as many boards as you want– just keep in mind the $100 gra

##### Are international customs fees covered?

No, we unfortunately cannot reimburse for the cost of taxes and duties for your PCB shipment. However, certain vendors do offer shipping options that prepay customs, and we recommend using them.
No, we unfortunately cannot reimburse for the cost of taxes and duties for your PCB shipment. However, certain vendors do offer shipping options that prepay customs, and we recommend using them. The "Standard Global Direct Line" shipping option is cost-effective and usually has no customs fees, but this shipping method is rarely offered; if you're offered this shipping option, take it!

##### Does the entire board have to cost less than $100?

The board may have a budget exceeding $100. However, you would be responsible for covering the difference by adding money to your Hack Club Bank account.

##### What if I need more funds than initially planned?

If your initial grant is less than $100, and you find yourself needing more to order extra parts, reach out to the Bank team at bank@hackclub.com to request additional funds.
If your initial grant is less than $100, and you find yourself needing more to order extra parts, reach out to the Onboard Team on Slack in #electronics or #onboard-help to request additional funds.

##### When will my pull request be reviewed?

Expand All @@ -43,3 +43,6 @@ No fee! It'd be kinda weird to give you the $100, and then take $7 back. The 7%
##### Should my budget include shipping and taxes?

Please do include shipping and taxes so the grant amount you receive will be as close as possible to your project expenses.

#### I only received 50$ in my grant, how come?
Following a [Hack Club Jam Tutorial](https://jams.hackclub.com/tag/pcb) grants you $50 out of the $100 grant. This amount is based on the average cost of ordering a board using the tutorial, which should be no more than $50. To receive the remaining $50, submit a new PCB, either by following another jam or by creating your own. After your second pull request has been approved, see [here](#what-if-i-need-more-funds-than-initially-planned) for obtaining the rest of your grant.
Binary file added docs/images/ordering/stencil.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
16 changes: 15 additions & 1 deletion docs/ordering_from_JLCPCB.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,9 @@ PCB fabs have *A LOT* of settings for board manufacturing, and JLCPCB is no exce


### PCB Assembly
Choose one of of the two assembly options for your PCB, [assembly by JLCPCB](#assembly-by-jlcpcb) is the quickest and easiest.

#### Assembly by JLCPCB
![](images/ordering/assembly.png)

- **PCBA Type**: Economic. Standard PCBA is very expensive. Some parts, like some connectors and daughter boards, or alternate board thicknesses (other than 1.6mm) require Standard PCBA.
Expand All @@ -64,8 +66,20 @@ Then, on the orientation screen, make sure all your assembly components are rota

[^orient]: Recall that components like resistors and ceramic capacitors are symmetrical, but diodes, LEDs, and ICs are not.

#### Assemble yourself with a stencil
Don't want to pay extra to JLCPCB for assembly? DIY assembly is a great way to save costs and learn a little at the cost that you'll have to supply your own components and have the appropriate tools.

This option is for ***advanced hackers*** only.

At a minimum, you'll need to have a soldering iron + solder, solder paste and a heat gun or heated solder reflower.

**Select the Stencil option in JLCPCB**
![JLCPCB Stencil Ordering](/docs/images/ordering/stencil.png)

See [How to use a PCB Stencil](https://www.youtube.com/watch?v=5AyxuuFjZSI) and [How to Use PCB Stencil-Step by Step Guideline](https://www.pcbelec.com/how-to-use-pcb-stencil.html) for some guides on how to start the process.

### Cart
After you reach the cart, click on checkout and fill out the information.
After you reach the cart, **click checkout** and fill out the information.

> To avoid excess shipping fees or customs, check out [`the Shipping Tips`](../community/shipping.md) doc!
Expand Down
Binary file not shown.
Loading

0 comments on commit b68062d

Please sign in to comment.