Start coding
Public vendor user guides are a capability checklist, not source to copy. Full text: CONTRIBUTING.md.
First patch
- Talk in Discussions or pick a good first issue.
- Fork, clone, branch from
master. - Build (Start). Gold: WNS_PS=9640.
- One change, one crate when you can. Iterate with
cargo test -p CRATE --lib TESTNAME. - Open a PR. Fill the template. Do not regress the gold counter.
Where to look
| Want | Path |
|---|---|
| SV ingest | crates/helion-sv |
| STA / XDC | crates/helion-sta |
| Place / route / bits | helion-place, helion-route, helion-bits |
| IDE model + tests | crates/helion-gui/src/ide.rs |
| IDE paint | crates/helion-gui/src/bin/helion-ide.rs |
| Chrome / floorplan fit | crates/helion-gui/src/chrome.rs |
| Parts | devices/helion/ |
| Examples | examples/ |
| This site | docs/ |
Rules that fail the PR
unsafeexcept documented islands (none in 0.1).- UNISIM names, vendor Tcl, Project X-Ray, 7-series / UltraScale / Lattice / Intel bitstream backends.
- AXI interconnect as Helion IP (use Helion-MM/ST).
- Skipping a missing
examples/ysyx_ibex.svin tests that claim to ingest it. - Changing gold WNS without updating the QoR table with a reason.