From c049df2a2e6a5e38cf7143198657ce89c1a5c94c Mon Sep 17 00:00:00 2001 From: Marshall Bowers Date: Fri, 14 Feb 2025 15:40:52 -0500 Subject: [PATCH] docs: Add section on file icons to `CONTRIBUTING.md` (#24905) This PR adds a section on file icons to the `CONTRIBUTING.md` guide. Release Notes: - N/A --- CONTRIBUTING.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6cd18ce421..843d6f33a1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -37,6 +37,20 @@ We plan to set aside time each week to pair program with contributors on promisi - Pair with us and watch us code to learn the codebase - Low effort PRs, such as those that just re-arrange syntax, won't be merged without a compelling justification +## File icons + +Zed's default icon theme consists of icons that are hand-designed to fit together in a cohesive manner. + +We do not accept PRs for file icons that are just an off-the-shelf SVG taken from somewhere else. + +### File icon associations + +We will happily accept PRs that add new file icon associations to [`file_types.json`](assets/icons/file_icons/file_types.json) to allow them to be targeted by [icon themes](https://zed.dev/docs/extensions/icon-themes). + +### Adding new icons to the Zed icon theme + +If you would like to add a new icon to the Zed icon theme, [open a Discussion](https://github.com/zed-industries/zed/discussions/new?category=ux-and-design) and we can work with you on getting an icon designed and added to Zed. + ## Bird's-eye view of Zed Zed is made up of several smaller crates - let's go over those you're most likely to interact with: