aboutsummaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorKarl Schultz <karl@lunarg.com>2016-03-09 12:48:04 -0700
committerKarl Schultz <karl@lunarg.com>2016-03-09 12:48:04 -0700
commitb5e3b3935185df425945c6fbc4c378bf2d89cf83 (patch)
tree0eae56821bb3f996417e4544fb015a9828bb193a /CONTRIBUTING.md
parentabed9e5964fe166f64286357b06f0083366007bb (diff)
downloadvulkan-validation-layers-b5e3b3935185df425945c6fbc4c378bf2d89cf83.tar.gz
Update CONTRIBUTING.md
Rework info so that it can be used in the three repos.
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md56
1 files changed, 41 insertions, 15 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index d95b6e72e..77d8ff7f7 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,16 +1,31 @@
-## How to Contribute to Vulkan-LoaderAndValidationLayers
+## How to Contribute to Vulkan Source Repositories
+
+### **The Repositories**
+
+The Vulkan source code is distributed across several GitHub repositories.
+The repositories sponsored by Khronos and LunarG are described here.
+In general, the canonical Vulkan Loader and Validation Layers sources are in the Khronos repository,
+while the LunarG repositories host sources for additional tools and sample programs.
+
+* [Khronos Vulkan-LoaderAndValidationLayers](https://github.com/KhronosGroup/Vulkan-LoaderAndValidationLayers)
+* [LunarG VulkanTools](https://github.com/LunarG/VulkanTools)
+* [LunarG VulkanSamples](https://github.com/LunarG/VulkanSamples)
+
+As a convenience, the contents of the Vulkan-LoaderAndValidationLayers repository are downstreamed into the VulkanTools and VulkanSamples repositories via a branch named `trunk`.
+This makes the VulkanTools and VulkanSamples easier to work with and avoids compatibility issues
+that might arise with Vulkan-LoaderAndValidationLayers components if they were obtained from a separate repository.
### **How to Submit Fixes**
-* **Ensure that the bug was not already reported or fixed** by searching on GitHub under [Issues](https://github.com/KhronosGroup/Vulkan-LoaderAndValidationLayers/issues)
- and
- [Pull Requests](https://github.com/KhronosGroup/Vulkan-LoaderAndValidationLayers/pulls).
+* **Ensure that the bug was not already reported or fixed** by searching on GitHub under Issues
+ and Pull Requests.
* Use the existing GitHub forking and pull request process.
This will involve [forking the repository](https://help.github.com/articles/fork-a-repo/),
creating a branch with your commits, and then [submitting a pull request](https://help.github.com/articles/using-pull-requests/).
* Please base your fixes on the master branch. SDK branches are generally not updated except for critical fixes needed to repair an SDK release.
-* Please include the GitHub Issue or Pull Request number near the beginning of the commit text.
- * Example: "GitHub PR 123: Fix missing init"
+* Please include the GitHub Issue number near the beginning of the commit text if applicable.
+ * Example: "GitHub 123: Fix missing init"
+* If your changes are restricted only to files from the Vulkan-LoaderAndValidationLayers repository, please direct your pull request to that repository, instead of VulkanTools or VulkanSamples.
#### **Coding Conventions and Formatting**
@@ -18,21 +33,18 @@
* Run clang-format on your changes to maintain formatting.
* There are `.clang-format files` throughout the repository to define clang-format settings
which are found and used automatically by clang-format.
- * Note that there are some files that may not have been run through clang-format.
- These should be obvious from their appearance and the number of changes that clang-format would make.
- Don't format these files.
- In other words, please run clang-format on your changes where appropriate.
* A sample git workflow may look like:
> # Make changes to the source.
> $ git add .
-> $ clang-format -i < list of changed code files >
+> $ clang-format -style=file -i < list of changed code files >
> # Check to see if clang-format made any changes and if they are OK.
> $ git add .
> $ git commit
#### **Testing**
-* Run the existing tests in the repository before and after your changes to check for any regressions.
+* Run the existing tests in the repository before and after your changes to check for any regressions.
+ There are some tests that appear in all repositories.
These tests can be found in the following folders inside of your target build directory:
(These instructions are for Linux)
* In the `demos` directory, run:
@@ -51,14 +63,28 @@
* Note that some tests may fail with known issues or driver-specific problems.
The idea here is that your changes shouldn't change the test results, unless that was the intent of your changes.
+* Run tests that explicitly exercise your changes.
* Feel free to subject your code changes to other tests as well!
### **Contributor License Agreement (CLA)**
+#### **Khronos Repository (Vulkan-LoaderAndValidationLayers)**
+
The Khronos Group is still finalizing the CLA process and documentation,
so the details about using or requiring a CLA are not available yet.
In the meantime, we suggest that you not submit any contributions unless you are comfortable doing so without a CLA.
-### **Large or New Contributions**
-
-All contributions made to the Vulkan-LoaderAndValidationLayers repository are Khronos branded and as such any new files need to have the Khronos license (MIT like) and copyright included. You can include your individual copyright after the Khronos copyright. See an existing file as an example.
+#### **LunarG Repositories**
+
+You'll be prompted with a "click-through" CLA as part of submitting your pull request in GitHub.
+
+### **License and Copyrights**
+
+All contributions made to the Vulkan-LoaderAndValidationLayers repository are Khronos branded and as such,
+any new files need to have the Khronos license (MIT like) and copyright included.
+Please see an existing file in this repository for an example.
+
+All contributions make to the LunarG repositories are to be made under the MIT license
+and any new files need to include this license and any applicable copyrights.
+
+You can include your individual copyright after any existing copyrights.