openharmony/third_party_vulkan-loader
1
0
Fork 0
mirror of https://gitee.com/openharmony/third_party_vulkan-loader synced 2025-02-17 06:07:51 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Update Contributing.md file

Browse Source 
Add more detail on running and writing tests.
This commit is contained in:
Mark Young 2022-02-16 10:40:28 -07:00
parent be01dafa1e
commit a32af9ca72
1 changed files with 12 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
CONTRIBUTING.md
View File

@ -45,6 +45,8 @@ current assignee.
* Please base your fixes on the master branch.
SDK branches are generally not updated except for critical fixes needed to
repair an SDK release.
* Provide one or more tests which show a failure for the issue before your changes
but pass successfully with your changes.
* The resulting Pull Request will be assigned to a repository maintainer.
It is the maintainer's responsibility to ensure the Pull Request
passes the Google/LunarG internal CI processes.
@ -119,13 +121,16 @@ scripts and before building and testing your changes. More details can be found
#### Testing Your Changes
* Run the existing tests in the `tests` directory of the repository
before and after each of your commits to check for any regressions.
* Linux: `run_all_tests.sh`
* Windows: `run_all_tests.ps1`
* Run tests that explicitly exercise your changes.
* Feel free to subject your code changes to other tests as well!
* In order to run tests, you must first build the loader with testing enabled (see details
in the BUILD.md file).
* If your changes expose an issue not previously tested against, please also provide one or more
tests which show a failure for the issue before your changes but pass successfully with your changes.
* Once built, simply change to the build folder, and type "ctest"
* This will run all tests the loader has defined at the time
* Additionally, once your change has begun the process of reviewing in Github,
it may be processed through the CI system.
* This may show additional failures on other platforms, so watch and be prepared to fix any
additional issues.
#### Coding Conventions for [CMake](http://cmake.org) files