Thanks for helping. Bugs, component requests and pull requests are all welcome.
- Try the component live at https://elygpui.com/components/ first; it may already do what you need.
- Open an issue from a template (Bug Report, Component Request or Other) before a large change, so we agree on the shape first.
- Rust 1.98 with
rustup target add wasm32-unknown-unknown. No full Xcode needed: gpui compiles its shaders at runtime. - For the website: Node 24 and pnpm 11.
- Development happens on macOS; the capture tool needs it.
cargo run -p ely-gallery # every chapter, light and dark
cargo run -p ely-gallery -- --page forms- A component lives in
src/<chapter>/, one folder per chapter. One component, one home; anything that duplicates another points to it. - Its demo is a story on the chapter's page,
crates/ely-gallery/src/pages/<chapter>.rs. After adding or renaming a story, runpython3 scripts/stories.py. TASKS.mdandtasks/track every component; tick its line when it lands.- The website is
frontend/; its README section has the commands.
The root AGENTS.md holds what every change needs; crates/ely-core/AGENTS.md holds the component rules every crate follows, and each crate or folder's own AGENTS.md adds its rules. Decisions are in docs/adr/. The ones reviews catch most:
- Colors, sizes, radii and shadows come from
cx.theme(); no rawpx()in components. Spacing uses gpui's rem helpers. - Every component works in light and dark, at 280px wide, by keyboard (Tab reaches it, a 1px focus ring shows, Enter and Space press it), and holds still under reduced motion.
- Fail fast and log state changes; no silent fallbacks.
- A file holds one responsibility;
scripts/check.shwarns past 800 lines and never fails on size. A file under 40 lines is a module entry or a type of its own. Comments are one short line, and rare. - A new rule or dependency gets a line in the
AGENTS.mdnearest the code it governs; a decision gets a record indocs/adr/.
scripts/check.sh # fmt, clippy, tests, the web lint, house rules
cd frontend && pnpm test && pnpm build && pnpm e2e # when you touch the websiteCI runs the same on every pull request. Fill in the pull request template: what and why, light and dark screenshots for anything that draws.
Ely is MIT. Unless you say otherwise, what you contribute is licensed the same way.
-
Fork https://github.com/ELY-Open-Source/Ely-GPUI-Components and clone your fork:
git clone https://github.com/<you>/Ely-GPUI-Components.git
-
Commit on a branch, push it to your fork, and open a pull request against
main. -
To update the pull request, push to the same branch.