feat: Add pre-commit (#939)

* feat: add pre-commit

* copyright fixes

* feat: pre-commit CI

* ignore copyright

* fix: dont fail on pre-commit ci

* add contributing docs

.copyrightignore

@@ -27,3 +27,4 @@ khrplatform.h
 clang_format.py
 run-clang-tidy.py
 package-list.txt
+.pre-commit-config.yaml

.github/workflows/check.yml

@@ -94,3 +94,12 @@ jobs:
     - run: cmake -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -Bbuild/clang
     - run: |
         /usr/bin/run-clang-tidy -j $(($(nproc)/2+1)) -p build/clang -header-filter=framework,samples,app -checks=-*,google-*,-google-runtime-references -quiet ${{ needs.changed-files.outputs.all }}
+
+  pre-commit:
+    name: Pre-Commit Checks
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v3
+      - uses: pre-commit/action@v3.0.1
+        continue-on-error: true # we currently don't track pre-commit warnings as errors. in the future this will change. for this step to pass we will need to run `pre-commit run --all-files`

.pre-commit-config.yaml

@@ -0,0 +1,12 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.3.0
+    hooks:
+    -   id: check-yaml
+    -   id: end-of-file-fixer
+    -   id: trailing-whitespace
+-   repo: https://github.com/pre-commit/mirrors-clang-format
+    rev: 'v15.0.7'
+    hooks:
+    -   id: clang-format
+        'types_or': [c++, c]

CONTRIBUTING.adoc

@@ -32,6 +32,28 @@ If you have a sample that demonstrates Vulkan like any of the above points, then
 Before you start, check out the requirements and guidelines below.
 Following these guidelines can help ensure that your contribution ends up being approved by reviewers and most importantly becomes a valuable addition to the Vulkan Samples repository.
 
+== Quality Checks
+
+Vulkan Samples has a range of quality checks to ensure that we maintain a consistent quality and style across all samples. These include formatting, linting and copyright checks.
+
+To make this process as painless for contributors as possible we use xref:https://pre-commit.com/[pre-commit]. To install pre-commit and the hooks for this repository, run the following commands:
+
+----
+pip install pre-commit
+pre-commit install
+----
+
+If you prefer not to use pre-commit, you can run the checks manually using the following commands:
+
+----
+# Run clang-format
+./scripts/clang_format.py main
+# Run copyright checks
+./scripts/copyright.py main --fix
+----
+
+Future tooling may be added in the future. If you have any suggestions or feedback, please open an issue on the repository.
+
 == Repository Structure
 
 |===

components/unix/include/unix/context.hpp

@@ -1,4 +1,4 @@
-/* Copyright (c) 2023, Thomas Atkinson
+/* Copyright (c) 2023-2024, Thomas Atkinson
  *
  * SPDX-License-Identifier: Apache-2.0
  *
@@ -34,4 +34,4 @@ class UnixPlatformContext final : public PlatformContext
 	UnixPlatformContext(int argc, char **argv);
 	~UnixPlatformContext() override = default;
 };
-}        // namespace vkb
+}        // namespace vkb