archive-gh-me/wgpu
1
0
Fork 0
mirror of https://github.com/gfx-rs/wgpu.git synced 2025-12-08 21:26:17 +00:00
Code Issues Projects Releases Wiki Activity

Mention Vulkan SDK requirement in CONTRIBUTING.md

Browse Source
This commit is contained in:
Connor Fitzgerald 2025-02-27 12:44:05 -05:00 committed by Erich Gubler
parent da0b68dde3
commit 7f87994c3f
1 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
CONTRIBUTING.md
View File

@ -96,10 +96,15 @@ We use the following components in a WGPU development environment:
pointed to by `rust-toolchain.toml` at the root of the repository, to compile pointed to by `rust-toolchain.toml` at the root of the repository, to compile
WGPU's code. WGPU's code.
- [Taplo](https://taplo.tamasfe.dev/) to keep TOML files formatted. - [Taplo](https://taplo.tamasfe.dev/) to keep TOML files formatted.
- [Vulkan SDK](https://vulkan.lunarg.com/) to provide Vulkan validation layers
and other Vulkan/SPIR-V tools for testing.
Once these are done, you should be ready to hack on WGPU! Drop into your Once these are done, you should be ready to hack on WGPU! Drop into your
favorite editor, make some changes to the repository's code, and test that WGPU favorite editor, make some changes to the repository's code, and test that WGPU
has been changed the way you expect. We recommend has been changed the way you expect. Take a look at [`docs/testing.md`] for more
info on testing.
When testing your own code against your patch, we recommend
[using a `path` dependency][path-deps] in Cargo for local testing of changes, [using a `path` dependency][path-deps] in Cargo for local testing of changes,
and a [`git` dependency][git-deps] pointing to your own fork to share changes and a [`git` dependency][git-deps] pointing to your own fork to share changes
with other contributors. with other contributors.