Open febbraro opened 7 years ago
Expanded the initial note into a full new contributor orientation.
Note that #90 points out a problem with the current error logging: namely that it can interference with the output of completely unrelated commands. That is not necessarily in scope here but refactoring should keep in mind that we'd prefer to give the caller more control over when & how this logging happens.
Our new static analysis tooling identified ProjectConfig.ValidateProjectScripts as failing on cyclomatic complexity. That's a fancy phrase for "too much nesting of logic/too much code in one function".
Notes
nolint
directive in the function comment to disabling this linting rule, in order to pass this issue, be sure to remove that comment first.Testing
docker-compose run --rm lint
to apply the full suite of static analysis tools. If there is a failure, you aren't done yet!docker-compose run --rm compile
to confirm your code compiles../build/darwin/rig
) to test that validation works... navigate to a project, reference this binary instead of your global rig, and see howrig project help
works.