Skip to content

docs: Update CONTRIBUTING to reference soundness checks and remove advice to run locally #97

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 16, 2025

Conversation

heckj
Copy link
Collaborator

@heckj heckj commented Apr 15, 2025

Motivation

scripts/soundness.sh was deleted in #5 which moved CI to GitHub Actions.

resolves #96

Modifications

Remove the instruction to run scripts/soundness.sh from CONTRIBUTING.md.

Result

Documentation no longer refers to nonexistent scripts.

Test Plan

No functional change.

@euanh euanh changed the title Update CONTRIBUTING to reference soundness checks and remove advice to run locally docs: Update CONTRIBUTING to reference soundness checks and remove advice to run locally Apr 16, 2025
@euanh euanh self-requested a review April 16, 2025 07:49
@euanh
Copy link
Collaborator

euanh commented Apr 16, 2025

@heckj Thank you! I missed this in the switch to GitHub Actions.

I found the same problem in apple/swift-openapi-generator#763 and swiftlang/swift-sdk-generator#206. These projects probably all started from the same template repository so we should check that the template is correct.

@euanh euanh merged commit 7229c3a into apple:main Apr 16, 2025
23 checks passed
@euanh euanh added area/documentation Improvements or additions to documentation semver/none No version bump required. labels Apr 16, 2025
@heckj heckj deleted the update-contributing branch April 16, 2025 14:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Improvements or additions to documentation semver/none No version bump required.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Can't follow advice to use soundness script when submitting a patch
2 participants