From 9d9f78dc55563e7072a452f030b8ec624294d45e 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 Utilities/soundness.sh was deleted in #199 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 | 25 +------------------------ 1 file changed, 1 insertion(+), 24 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2acd53b5..10ce9c45 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -58,29 +58,6 @@ We require that your commit messages match our template. The easiest way to do t git config commit.template Utilities/git.commit.template -### Run `./Utilities/soundness.sh` - -The scripts directory contains a [`soundness.sh` script](https://github.com/apple/swift-sdk-generator/blob/main/Utilities/soundness.sh) -that enforces additional checks, like license headers and formatting style. - -Please make sure to run `./Utilities/soundness.sh` before pushing a change upstream, otherwise it is likely the PR validation will fail -on minor changes such as formatting issues. - -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 "Utilities/soundness.sh" ]]; then - Utilities/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-sdk-generator. Make sure the CI passes, and then wait for code review. \ No newline at end of file +Please open a pull request at https://github.com/apple/swift-sdk-generator. Make sure the CI passes, and then wait for code review.