From 0a15d280b17d8e8d9822592347a580ba7e573740 Mon Sep 17 00:00:00 2001 From: AllSpiceUser Date: Mon, 28 Aug 2023 20:23:21 -0500 Subject: [PATCH] Add component update request, moved templates, add design review component template --- .../issue_template}/new_component_request.yml | 0 .../update_component_request.yml | 67 +++++++++ .allspice/pull_request_template.md | 141 ++++++++++++++++++ 3 files changed, 208 insertions(+) rename {issue_template => .allspice/issue_template}/new_component_request.yml (100%) create mode 100644 .allspice/issue_template/update_component_request.yml create mode 100644 .allspice/pull_request_template.md diff --git a/issue_template/new_component_request.yml b/.allspice/issue_template/new_component_request.yml similarity index 100% rename from issue_template/new_component_request.yml rename to .allspice/issue_template/new_component_request.yml diff --git a/.allspice/issue_template/update_component_request.yml b/.allspice/issue_template/update_component_request.yml new file mode 100644 index 0000000..61f598d --- /dev/null +++ b/.allspice/issue_template/update_component_request.yml @@ -0,0 +1,67 @@ +name: Update component request +about: Request a component to be updated/deleted +title: "[Update component request]: " +body: + - type: markdown + attributes: + value: Request a component to be updated/deleted + + # Justification + - type: input + id: what + attributes: + label: Requested changes + description: Describe requested changes + placeholder: "Add thermal pad to footprint" + value: "" + validations: + required: true + + # Where used + - type: input + id: where-used + attributes: + label: Affected components + description: List what components are affected + placeholder: "All quad flat pack footprints with ground pads" + value: "" + + # Part numbers + - type: textarea + id: description + attributes: + label: Description + description: Describe the changes you'd like to make + placeholder: "Update all footprints of quad packages that have footprints to include the thermal ground pad" + value: "" + render: "true" + validations: + required: true + + # Checklist + - type: checkboxes + id: checklist + attributes: + label: Checklist + options: + - label: Checked library for existing parts + - label: Price check + - label: QTY check + - label: Lead time check + - label: Distributor part number + - label: Datasheet review + - label: Symbol review + - label: Footprint review + - label: Component check (symbol+footprint review) + - label: Package check + - label: Dimension check + - label: Automotive grade + - label: Space grade + - label: FMEA analysis + + + - type: markdown + attributes: + value: | + ## Attach files + (datasheet, design notes, firmware) \ No newline at end of file diff --git a/.allspice/pull_request_template.md b/.allspice/pull_request_template.md new file mode 100644 index 0000000..7459587 --- /dev/null +++ b/.allspice/pull_request_template.md @@ -0,0 +1,141 @@ +--- + +name: "AllSpice component review template" +about: "Optional description" + +--- + +*This short description prepends any pull request. It is fully markdown compatible. See [markdown guide](https://www.markdownguide.org/cheat-sheet/) for examples of what you can do!* + +## Resolved Issues + +... + +## Description + +... + +## Design Review Checklist +### Process +- [ ] Commits in correct branch +- [ ] File names follow standard +- [ ] Update project README page +### System +- [ ] Power + - [ ] Supply rated for necessary country specifications + - [ ] Estimated total worst-case power supply draw +- [ ] Connectors + - [ ] Sufficient Current and Voltage rating + - [ ] Mating connectors have matching pinout + - [ ] Same contact material specified for mating connectors +- [ ] Testing + - [ ] Test procedure written +- [ ] Environmental + - [ ] Specified min/max operating temperature + - [ ] Specified min/max storage temperature + - [ ] Specified min/max humidity +- [ ] ROHS compliance requirement review +### Components +- [ ] Components meet environmental specifications +- [ ] All components have quantity, reference designator and description +- [ ] Suggested and alternate manufacturers listed +- [ ] Price and stock checked for each component +- [ ] Component derating + - [ ] Voltage + - [ ] Current + - [ ] Power at worst-case operating temperature + - [ ] Temperature at worst-case power +### Schematics +- [ ] Microcontrollers / ICs + - [ ] Check the data sheet errata and apnotes for weird IC behaviors +- [ ] Busses + - [ ] UART/USART TX->RX and RX<-TX + - [ ] I2C SDA and SCL pins correct(https://www.ti.com/lit/an/slva689/slva689.pdf) +- [ ] Analog + - [ ] Sufficient power rails for analog circuits + - [ ] Amplifiers checked for stability + - [ ] Consider signal rate-of-rise and fall for noise radiation +- [ ] General + - [ ] Sufficient bulk capacitance calculated + - [ ] Polarized components checked + - [ ] Electrolytic/tantalum capacitors checked for no reverse voltage + - [ ] Electrolytic/tantalum capacitors temperature/voltage derating sufficient for MTBF + - [ ] Check pin numbers of all custom-generated parts + - [ ] Check reverse base-emitter current/voltage on bipolar transistors + - [ ] Power nets use preferred and consistent naming (ex. no `3.3V` vs `+3.3V`) + - [ ] Debug resources added by design (leds, serial ports, etc.) even if unpopulated by default +### PCB +- [ ] Manufacturing + - [ ] PCB manufacturing requirements noted on `fab` layer + - [ ] Plating specified + - [ ] Plating material + - [ ] Plating thickness + - [ ] Layer stack-up specified + - [ ] Minimum trace/space specified + - [ ] Minimum hole size specified + - [ ] Controlled impedance specified + - [ ] Blind or buried vias specified +- [ ] Footprints + - [ ] Pin 1 marked in a consistent manner + - [ ] Component polarity marked + - [ ] Diodes, LEDs + - [ ] Electrolytic, tantalum capacitors + - [ ] Keyed components like connectors + - [ ] Footprint dimensions cross-checked with datasheet recommendation + - [ ] Sufficient thermal pads on high-power components or nets +- [ ] Clearance + - [ ] Keep-out areas honored + - [ ] Around mounting holes + - [ ] For programming tools + - [ ] For assembly tools (wrenches, screwdrivers etc.) + - [ ] For connectors + - [ ] Trace-to-trace clearance based upon voltage rating + - [ ] Component size based upon voltage rating +- [ ] Mechanical + - [ ] CAD file uploaded + - [ ] Clearance above connectors + - [ ] Clearance below through-hole components + - [ ] Mounting holes electrically isolated if necessary + - [ ] Mounting holes have via stitching + - [ ] Hole diameters leave margin for plating +- [ ] Electrical + - [ ] ERC passes + - [ ] Isolation barriers are large enough +- [ ] Signal integrity + - [ ] Gaps in ground planes checked and minimized + - [ ] High-speed signals avoid gaps in ground planes + - [ ] Stubs minimized for high-speed signals + - [ ] Differential pair spacing based upon impedance matching + - [ ] Via fencing of sensitive RF transission lines done with the proper via spacing (< 1/20 lambda) + - [ ] Option for a shielding can over sensitive circuitry e.g. RF? +- [ ] Copper pour + - [ ] All planes have been poured + - [ ] Planes and pours checked for high-impedance paths + - [ ] No pour between adjacent pins on ICs +- [ ] Traces + - [ ] Trace-pad connections sufficiently obtuse (angle 90 deg or more) + - [ ] Trace widths sufficient for the current draw and max heating + - [ ] No connections between adjacent pins on ICs + - [ ] Vias for internal power traces sufficiently large + - [ ] Mitered bends or soft curves (r > 3 trace width) for impedance sensitive traces +- [ ] Thermal + - [ ] Temperature sensitive components placed away from hot components + - [ ] Thermal vias in thermal pads +- [ ] Silk screen + - [ ] Notes and documentation + - [ ] Updated revision number + - [ ] Updated date + - [ ] No silk screen over pads / vias + - [ ] Text is readable from at most two directions + - [ ] Silk screen size / font will legible after printing + - [ ] Connector pin-outs labeled + - [ ] Fuse size and type marked on PCB + - [ ] Functional groups marked + - [ ] Functionality labeled + - [ ] Test points + - [ ] LEDs + - [ ] Buttons + - [ ] Connectors/terminals + - [ ] Jumpers/fuses + + \ No newline at end of file -- 2.40.3