From c5ffb75afd88651dfe07a1463ad982ceff16d936 Mon Sep 17 00:00:00 2001 From: Euan Harris Date: Wed, 16 Apr 2025 08:35:57 +0100 Subject: [PATCH] docs: Delete instructions to run non-existent soundness.sh scripts/soundness.sh was deleted in #604 which moved CI to GitHub Actions. Credit to @heckj, who found the same problem in https://github.com/apple/swift-container-plugin/issues/96. --- CONTRIBUTING.md | 15 --------------- 1 file changed, 15 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index da1a1d4bd..5899fba36 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -89,21 +89,6 @@ directory, for example: --action-offline-mode ``` -For frequent contributors, we recommend adding the script as a [git pre-push hook](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks), which you can do via executing the following command in the project root directory: - -```bash -cat << EOF > .git/hooks/pre-push - -if [[ -f "scripts/soundness.sh" ]]; then - scripts/soundness.sh -fi -EOF -``` - -Which makes the script execute, and only allow the `git push` to complete if the check has passed. - -In the case of formatting issues, you can then `git add` the formatting changes, and attempt the push again. - ## How to contribute your work Please open a pull request at https://github.com/apple/swift-openapi-generator. Make sure the CI passes, and then wait for code review.