You've already forked incutec-OpenESC_20X20
mirror of
https://github.com/incutec-hw/OpenESC_20X20.git
synced 2026-08-08 21:55:45 +00:00
1dfa60c422
* Fix JST 3D model in lib, add wrl, re-render board images Same fix as OpenESC-30x30: the JST SM08B footprint's STEP model rendered the housing on stilts past the board edge. Replaced with the proven VRML model from OpenFC-Lite at offset (-3.5, 2.17, 0), derived from the pad geometry and verified by render. The J1 board-instance fix is in the working tree mixed with uncommitted layout and schematic work and will be committed with it; renders reflect that current state, verified IC by IC on both sides. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * chore: point every GitHub link at OpenDrone-hw The org was renamed from incutec-hw to OpenDrone-hw. Old links only work through GitHub's rename redirect, which stops working as soon as the incutec-hw name is registered again for the company org. Docs and submodule URLs only. No design files touched. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
59 lines
1.8 KiB
Markdown
59 lines
1.8 KiB
Markdown
# Contributing
|
|
|
|
## Before you edit a board
|
|
|
|
KiCad files cannot be merged. If two people edit the same `.kicad_pcb`, one of
|
|
them loses the work.
|
|
|
|
1. Open an issue describing the change and wait for the maintainer to agree.
|
|
2. Claim the file: `git lfs lock <path>.kicad_pcb`
|
|
3. `git lfs locks` shows who holds what. If a file is held, talk to that person
|
|
in the issue instead of starting anyway.
|
|
4. After the pull request is merged: `git lfs unlock <path>.kicad_pcb`
|
|
|
|
A pull request touching a file locked by someone else gets closed, not merged.
|
|
|
|
## Setup
|
|
|
|
```
|
|
git clone --recursive https://github.com/OpenDrone-hw/OpenESC-20x20.git
|
|
```
|
|
|
|
KiCad 10. The `--recursive` flag pulls `libs/KiCad-Library`, which the project
|
|
library tables reference for shared parts. Edit in KiCad; never text-edit
|
|
`.kicad_sch` or `.kicad_pcb`.
|
|
|
|
## Before opening a pull request
|
|
|
|
- ERC and DRC clean on every board you touched:
|
|
|
|
```
|
|
kicad-cli sch erc --exit-code-violations hardware/4in1-mini.kicad_sch
|
|
kicad-cli pcb drc --exit-code-violations hardware/4in1-mini.kicad_pcb
|
|
```
|
|
|
|
- Post before and after board renders in the pull request. A text diff of a
|
|
PCB is not reviewable.
|
|
- Say what you tested on real hardware, or say that you tested nothing.
|
|
|
|
## Parts
|
|
|
|
Add new symbols, footprints and 3D models to this repo's local libraries.
|
|
That is the working default.
|
|
|
|
[OpenDrone-hw/KiCad-Library](https://github.com/OpenDrone-hw/KiCad-Library) is a
|
|
mirror of parts we already use or stock. Check it first: if the part is there,
|
|
we have used it before, which saves sourcing work. Promoting a part into it is
|
|
a separate deliberate step, not a requirement for contributing here.
|
|
|
|
Prefer LCSC basic parts.
|
|
|
|
## Licensing
|
|
|
|
Hardware contributions are licensed CERN-OHL-S-2.0, the same as the project.
|
|
Sign off your commits with `git commit -s` to certify you wrote the work.
|
|
|
|
## Questions
|
|
|
|
Open a GitHub issue.
|