Skip to content

armgit / zed

Public Imported from GitHub
0

Code at the speed of thought – Zed is a high-performance, multiplayer code editor from the creators of Atom and Tree-sitter.

Include icon guidelines in PR templates and contribution docs (#58855)

Danilo Leal7eda38207a70
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index a56793ad622..c9ada8f20f2 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -2,7 +2,7 @@ Self-Review Checklist:
- [ ] I've reviewed my own diff for quality, security, and reliability
- [ ] Unsafe blocks (if any) have justifying comments
-- [ ] The content is consistent with the [UI/UX checklist](https://github.com/zed-industries/zed/blob/main/CONTRIBUTING.md#uiux-checklist)
+- [ ] The content adheres to Zed's UI standards ([UX/UI](https://github.com/zed-industries/zed/blob/main/CONTRIBUTING.md#uiux-checklist) and [icon](https://github.com/zed-industries/zed/blob/main/crates/icons/README.md) guidelines)
- [ ] Tests cover the new/changed behavior
- [ ] Performance impact has been considered and is acceptable
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 63133b57ed3..e0a3287387b 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -84,10 +84,10 @@ When your changes affect UI, consult this checklist:
- Do all keyboard shortcuts work as intended?
- Are shortcuts discoverable (tooltips, menus, docs)?
-- Do all mouse actions work (drag, context menus, resizing, scrolling)?
-- Does the feature look great in light mode and dark mode?
-- Are hover states, focus rings, and active states clear and consistent?
- Is it usable without a mouse (keyboard-only navigation)?
+- Do all mouse actions work (drag, context menus, resizing, scrolling)?
+- Does the feature look great in light and dark mode themes?
+- Are hover states and focus indicators clear and consistent?
**Responsiveness**
@@ -100,7 +100,7 @@ When your changes affect UI, consult this checklist:
**Platform Consistency**
-- Is the feature fully usable on Windows, Linux, and Mac?
+- Is the feature fully usable on Windows, Linux, and macOS?
- Does it respect system-level settings (fonts, scaling, input methods)?
**Performance**
@@ -113,6 +113,7 @@ When your changes affect UI, consult this checklist:
**Consistency**
- Does it match Zed’s design language (spacing, typography, icons)?
+ - Make sure to visit [the icon design guidelines](https://github.com/zed-industries/zed/blob/main/crates/icons/README.md)
- Are terminology, labels, and tone consistent with the rest of Zed?
- Are interactions consistent (e.g., how tabs close, how modals dismiss, how errors show)?
diff --git a/crates/icons/README.md b/crates/icons/README.md
index e340a00277d..e3b7c54c178 100644
--- a/crates/icons/README.md
+++ b/crates/icons/README.md
@@ -26,4 +26,4 @@ To introduce a new icon, add the `.svg` file to the `assets/icon` directory and
- SVG files in the assets folder follow a snake_case name format.
- Icons in the `icons.rs` file follow the PascalCase name format.
-Make sure to tag a member of Zed's design team so we can review and adjust any newly introduced icon.
+Make sure to tag a member of Zed's design team (@zed-industries/design) so we can review and adjust any newly introduced icon.