Skip to content

Commit

Permalink
add contributing docs
Browse files Browse the repository at this point in the history
  • Loading branch information
tomadamatkinson committed Feb 24, 2024
1 parent 386cfe3 commit fc5078d
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 2 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -98,8 +98,8 @@ jobs:
pre-commit:
name: Pre-Commit Checks
runs-on: ubuntu-latest
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`
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v3
- uses: pre-commit/[email protected]
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`
24 changes: 23 additions & 1 deletion CONTRIBUTING.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
////
- Copyright (c) 2019-2023, Arm Limited and Contributors
- Copyright (c) 2019-2024, Arm Limited and Contributors
-
- SPDX-License-Identifier: Apache-2.0
-
Expand Down Expand Up @@ -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

|===
Expand Down

0 comments on commit fc5078d

Please sign in to comment.