The source code for The Vulkan-Tools components is sponsored by Khronos and LunarG.
Repository Issue labels:
It is the maintainers goal for all issues to be assigned within one business day of their submission. If you choose to work on an issue that is assigned, simply coordinate with the current assignee.
Use the Google style guide for source code with the following exceptions:
Run clang-format on your changes to maintain consistent formatting
.clang-format files present in the repository to define clang-format settings which are found and used automatically by clang-format.
# Make changes to the source. $ git add -u . $ git clang-format --style=file # Check to see if clang-format made any changes and if they are OK. $ git add -u . $ git commit
Strive for commits that implement a single or related set of functionality, using as many commits as is necessary (more is better). That said, please ensure that the repository compiles and passes tests without error for each commit in your pull request. Note that to be accepted into the repository, the pull request must [pass all tests](#testing your changes) on all supported platforms -- the automatic Github Travis and AppVeyor continuous integration features will assist in enforcing this requirement.
icd/generated directory contains source code that is created by several generator scripts in the
scripts directory. All changes to these scripts must be submitted with the corresponding generated output to keep the repository self-consistent. This requirement is enforced by both Travis CI and AppVeyor test configurations. Regenerate source files after modifying any of the generator scripts and before building and testing your changes. More details can be found in BUILD.md.
Run the repository components with the Vulkan Validation Layers before and after each of your commits to check for any regressions.
(These instructions are for Linux)
cube directory, run:
vkcube vkcube --validate
vulkaninfo directory, run:
.cmake-format.py file in the repository to define the settings. See the cmake-format page for information about its simple markup for comments.
# ~~~ comment line before and after that block.
# cmake-format: off and
# cmake-format: on comment lines.
sudo pip install cmake_format
cmake-format --in-place $FILENAME
sed --in-place='' 's/^ *#/#/' $FILENAME
You will be prompted with a one-time “click-through” CLA dialog as part of submitting your pull request or other contribution to GitHub.
All contributions made to the Vulkan-Tools repository are Khronos branded and as such, any new files need to have the Khronos license (Apache 2.0 style) and copyright included. Please see an existing file in this repository for an example.
All contributions made to the LunarG repositories are to be made under the Apache 2.0 license and any new files need to include this license and any applicable copyrights.
You can include your individual copyright after any existing copyrights.