Lines Matching +refs:cmake +refs:indent +refs:line +refs:to
1 # How to Contribute to Vulkan Source Repositories
12 While there are often active and organized development efforts underway to improve their coverage,
13 there are always opportunities for anyone to help by contributing additional validation layer checks
16 There are a couple of methods to identify areas of need:
20 command line argument to see a list of as-yet unimplemented validation checks.
21 * Having selected a validation check to work on, it is often efficient to implement a block of rela…
22 at once. Refer to the validation database output from `vk_validation_stats.py` (available in text, …
23 or csv format) to identify related checks that may be implemented simultaneously.
25 Of course, if you have your own work in mind, please open an issue to describe it and assign it to …
26 Finally, please feel free to contact any of the developers that are actively contributing should you
27 wish to coordinate further.
33 * _Bug_: These issues refer to invalid or broken functionality and are the highest priorit…
34 * _Incomplete_: These issues refer to missing validation checks that users have encountered durin…
36 * _Enhancement_: These issues refer to ideas for extending or improving the validation layers.
39 It is the maintainers goal for all issues to be assigned or triaged within one business day of thei…
40 to work on an issue that is assigned, simply coordinate with the current assignee.
42 ### **How to Submit Fixes**
49 * Please read and adhere to the style and process [guidelines ](#coding-conventions-and-formatting)…
50 …. SDK branches are generally not updated except for critical fixes needed to repair an SDK releas…
51 …e resulting Pull Request will be assigned to a repository maintainer. It is the maintainer's respo…
58 …* The column limit is 132 (as opposed to the default value 80). The clang-format tool will handle …
59 …* The indent is 4 spaces instead of the default 2 spaces. Again, the clang-format tool will handle…
60 …eason for violating a rule in the guidelines, then you are free to do so. Be prepared to defend yo…
64 * Run **clang-format** on your changes to maintain consistent formatting
65 * There are `.clang-format` files present in the repository to define clang-format settings
68 …currently uses clang-format version 5.0.0 to check that the lines of code you have changed are for…
69 recommended that you use the same version to format your code prior to submission.
72 > # Make changes to the source.
75 > # Check to see if clang-format made any changes and if they are OK.
80 …* Limit the subject line to 64 characters -- this allows the information to display correctly in g…
81 …* Begin subject line with a one-word component description followed by a colon (e.g. build, docs, …
82 * Separate subject from body with a blank line
84 * Capitalize the subject line
85 * Do not end the subject line with a period
86 * Use the body to explain what and why vs. how
87 …* Use the imperative mode in the subject line. This just means to write it as a command (e.g. Fix …
91 that to be accepted into the repository, the pull request must [pass all tests](#testing your chang…
95 * Run the existing tests in the repository before and after each of your commits to check for any r…
111 * Feel free to subject your code changes to other tests as well!
114 Pull Requests to GitHub are tested in the cloud on Linux and Windows VMs. The Linux VMs use [Travis…
116 …/github.com/KhronosGroup/Vulkan-Tools/tree/master/icd). This is a fast way to simulate testing acr…
121 The test should cause your new validation check to identify the violation and issue a validation er…
124 This new test should be added to the validation layer test program in the `tests` directory and con…
128 contains checks that require significant amounts of application state to carry out. In contrast, th…
131 * **Validation Error/Warning Messages:** Strive to give specific information describing the partic…
132 …kan Objects and related values. Also, ensure that when messages can give suggestions about _how_ to
133 fix the problem, they should do so to better assist the user.
136 script with the consistency check (`-c`) argument to ensure that your changes have not introduced a…
138 generator scripts in the `scripts` directory. All changes to these scripts _must_ be submitted with…
139 corresponding generated output to keep the repository self-consistent. This requirement is enforced…
144 #### Coding Conventions for [CMake](http://cmake.org) files
148 * The indent is 4 spaces.
152 [cmake-format](https://github.com/cheshirekow/cmake_format)
153 using the `.cmake-format.py` file in the repository to define the settings.
154 See the cmake-format page for information about its simple markup for comments.
156 a `# ~~~` comment line before and after that block.
158 `# cmake-format: off` and `# cmake-format: on` comment lines.
160 * To run: `cmake-format --in-place $FILENAME`
161 * **IMPORTANT (June 2018)** cmake-format v0.3.6 has a
164 A workaround is to use the following command _before_ running cmake-format:
170 or other contribution to GitHub.
174 All contributions made to the Vulkan-ValidationLayers repository are Khronos branded and as such,
175 any new files need to have the Khronos license (Apache 2.0 style) and copyright included.
178 All contributions made to the LunarG repositories are to be made under the Apache 2.0 license
179 and any new files need to include this license and any applicable copyrights.