Open Garfeild opened 2 weeks ago
CONTRIBUTING.md describes that project provides way of basic validation of the changes by running scripts/soundness.sh.
CONTRIBUTING.md
scripts/soundness.sh
Unfortunately, this script doesn't provide meaningful results and fails for multiple reasons:
main
Cluster.Node
Cluster.Endpoint
validate_docc.sh
validate_format.sh
--lint
validate_instruments.sh
soundness.sh
Instruments
Motivation:
CONTRIBUTING.md
describes that project provides way of basic validation of the changes by runningscripts/soundness.sh
.Unfortunately, this script doesn't provide meaningful results and fails for multiple reasons:
main
branch contains large amount of code, which SwiftFormat tries to update to match rules;Modifications:
Cluster.Node
is added to documentation forCluster.Endpoint
, this fixesvalidate_docc.sh
scriptvalidate_format.sh
is updated to run SwiftFormat only against files, that are modified in the branch--lint
option is passed to SwiftFormat to not modify files during validation runvalidate_instruments.sh
is removed as step fromsoundness.sh
and from the projectInstruments
directory is removed as it contains only leftoversCONTRIBUTING.md
is updated with actual path to commits template.Result:
soundness.sh
provides right feedback for your current working branch.