organicmaps/Vulkan-Headers
13
Fork 0
mirror of https://github.com/KhronosGroup/Vulkan-Headers.git synced 2025-04-04 20:54:58 +00:00
Code Issues 1 Projects Releases Wiki Activity Actions

docs: Add CONTRIBUTING.md

Browse source
This commit is contained in:
Juan Ramos 2023-01-12 12:36:51 -07:00 • committed by Juan Ramos
parent 50f8b24b85
commit 460f75b518
2 changed files with 38 additions and 29 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

36
CONTRIBUTING.md Normal file
View file

@ -0,0 +1,36 @@
# CONTRIBUTING
Please note when contributing what files this repository actually is responsible for.
The majority for the Vulkan headers come from [Vulkan-Docs](https://github.com/KhronosGroup/Vulkan-Docs)
### This repository (https://github.com/KhronosGroup/Vulkan-Headers)
* BUILD.gn
* BUILD.md
* cmake/
* CMakeLists.txt
* tests/*
* CODE_OF_CONDUCT.md
* INTEGRATION.md
* LICENSE.txt
* README.md
* Non-API headers
* include/vulkan/vk_icd.h
* include/vulkan/vk_layer.h
* include/vulkan/vk_sdk_platform.h (deprecated)
### Specification repository (https://github.com/KhronosGroup/Vulkan-Docs)
* registry/*.py
* registry/spec_tools/*.py
* registry/profiles/*.json
* All files under include/vulkan/ which are *not* listed explicitly as originating from another repository.
### Vulkan C++ Binding Repository (https://github.com/KhronosGroup/Vulkan-Hpp)
As of the Vulkan-Docs 1.2.182 spec update, the Vulkan-Hpp headers have been
split into multiple files. All of those files are now included in this
repository.
* include/vulkan/*.hpp

31
README.md
View file

@ -9,36 +9,9 @@ If proposing changes to any file originating from a different repository,
please propose such changes in that repository, rather than Vulkan-Headers.
Files in this repository originate from:
### Specification repository (https://github.com/KhronosGroup/Vulkan-Docs)
## Contributing
* registry/*.py
* registry/spec_tools/*.py
* registry/profiles/*.json
* All files under include/vulkan/ which are *not* listed explicitly as originating from another repository.
### This repository (https://github.com/KhronosGroup/Vulkan-Headers)
* BUILD.gn
* BUILD.md
* cmake/
* CMakeLists.txt
* tests/*
* CODE_OF_CONDUCT.md
* INTEGRATION.md
* LICENSE.txt
* README.md
* Non-API headers
* include/vulkan/vk_icd.h
* include/vulkan/vk_layer.h
* include/vulkan/vk_sdk_platform.h
### Vulkan C++ Binding Repository (https://github.com/KhronosGroup/Vulkan-Hpp)
As of the Vulkan-Docs 1.2.182 spec update, the Vulkan-Hpp headers have been
split into multiple files. All of those files are now included in this
repository.
* include/vulkan/*.hpp
See the [CONTRIBUTING.md](CONTRIBUTING.md)
## Version Tagging Scheme