# Objective
Both our PR template and contribution guidelines are too convoluted.
This results in:
- contributors missing important information because the information is
buried in the contributing file
- worse commit descriptions post-merge due to the most important
information being buried and or a lot of boilerplate present
- the PR template often being neglected by staff themselves entirely
- more work for reviewers/engineer on triage here since they have to
repeatedly point people at the contribution gudelines
## Solution
In order to take a stab at improving this, this PR goes for the
following:
1. Shrink the PR template
- this aims at reducing the cognitive load looking at this and filling
it out whilst preserving all the important information needed for
reviewers
- a lot of text has been removed to make commit messages in the repo
more readable
- keep text still visible as opposed to having HTML comments so that
reviewers spot this and can raise
## Testing
Tested this by giving it a read myself and iterating with Kirill on the
final wording/sorting/organization of contents and files.
## Self-Review Checklist:
- [-] I've reviewed my own diff for quality, security, and reliability
- [-] Unsafe blocks (if any) have justifying comments
- [-] 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
## Showcase
<details>
<summary>The new contribution guidelines</summary>
<img width="1209" height="1293" alt="grafik"
src="https://github.com/user-attachments/assets/6a3f5012-7f46-48b7-add2-9f2400f01c57"
/>
</details>
<details>
<summary>The PR template in action</summary>
<img width="879" height="688" alt="grafik"
src="https://github.com/user-attachments/assets/87e5ad65-7ade-45b8-b8a8-8818c9a49ba8"
/>
</details>
---
Release Notes:
- N/A
---------
Co-authored-by: zelenenka <241371603+zelenenka@users.noreply.github.com>
## Screenshot testing
Adds visual testing infrastructure for GPUI that captures screenshots by
rendering directly to Metal textures. The
The screenshots end up in `target/visual_tests/` and look like this:
<img width="2560" height="1600" alt="workspace_with_editor2"
src="https://github.com/user-attachments/assets/54112343-4af1-4347-9bab-f099de97dd29"
/>
<img width="2560" height="1600" alt="project_panel2"
src="https://github.com/user-attachments/assets/0cd54b61-dace-4398-a28e-0b4d7c2968f6"
/>
### Key Features
- **Direct texture capture**: Screenshots are captured by rendering the
scene to a Metal texture and reading pixels directly from GPU memory,
rather than using ScreenCaptureKit
- **No visibility requirements**: Windows don't need to be visible on
screen since we read directly from the render pipeline
- **Deterministic output**: Captures exactly what GPUI renders, not what
the OS compositor displays
- **No permissions needed**: Doesn't require Screen Recording permission
like ScreenCaptureKit would
### Running the Visual Tests
```bash
# Run visual tests (compares against baselines)
cargo run -p zed --bin visual_test_runner --features visual-tests
# Update baseline images (when UI intentionally changes)
UPDATE_BASELINE=1 cargo run -p zed --bin visual_test_runner --features visual-tests
# View the captured screenshots
open target/visual_tests/
```
### Implementation
- `Window::render_to_image()` - Renders the current scene to a texture
and returns an `RgbaImage`
- `MetalRenderer::render_to_image()` - Core implementation that renders
to a non-framebuffer-only texture
- `VisualTestAppContext` - Test context that uses real macOS platform
rendering
- `VisualTestAppContext::capture_screenshot()` - Synchronous screenshot
capture using direct texture rendering
### Usage
```rust
let mut cx = VisualTestAppContext::new();
let window = cx.open_window(...)?;
let screenshot: RgbaImage = cx.capture_screenshot(window.into())?;
```
Release Notes:
- N/A
---------
Co-authored-by: Amp <amp@ampcode.com>
The documentation referenced a “Curated board of issues” GitHub Project
that no longer exists.
The linked project returns a 404, and only three public projects are
currently available under
zed-industries.
This PR removes the outdated reference. Documentation-only change.
Release Notes:
- N/A
This PR adds the ability for icon themes to provide their own file
associations.
The old `file_types.json` that was previously used to make these
associations has been removed in favor of storing them on the default
theme.
Icon themes have two new fields on them:
- `file_stems`: A mapping of file stems to icon keys.
- `file_suffixes`: A mapping of file suffixes to icon keys.
These mappings produce icon keys which can then be used in `file_icons`
to associate them to a particular icon:
```json
{
"file_stems": {
"Makefile": "make"
},
"file_suffixes": {
"idr": "idris"
},
"file_icons": {
"idris": { "path": "./icons/idris.svg" },
"make": { "path": "./icons/make.svg" }
}
}
```
When loading an icon theme, the `file_stems` and `file_icons` fields
will be merged with the ones from the base icon theme, with the values
from the icon theme being loaded overriding ones in the base theme.
Release Notes:
- Added the ability for icon themes to provide their own file
associations.
This PR updates the contributing docs to remove an outdated section
about extension support and instead point to the extension authoring
docs.
Release Notes:
- N/A