Add --help usage to install.sh and exit when invalid arg / Update contributing docs #421
+25
−3
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Upfront apologies
I apologize for not opening an issue first. Excuse:
- What I did
install.sh
will not exit with error when supplied invalid arguments.install.sh
for--help
argument.- How I did it
usage
function called when invalid argument is provided toinstall.sh
and script exits WITH error.usage
function with new supported--help
argument ininstall.sh
which will exit WITHOUT error.PULL_REQUEST_TEMPLATE.md
.PULL_REQUEST_TEMPLATE.md
to the repoREADME.md
.- How to verify it
1. Exit install.sh with usage and error on invalid argument
sh install.sh --invalid
BEFORE:
AFTER:
2. Exit install.sh with usage and NO error on
--help
argumentsh install.sh --help
BEFORE (same as above):
AFTER:
Regression tests: install still works
sh install.sh --dry-run
sh install.sh
Linted and tested locally
shellcheck:
test:
README Contributing section
- Description for the changelog
(I know this says one line for the whole PR but traditionally changelogs have one line per THING and my PR has 2 distinct things)
- A picture of a cute animal (not mandatory but encouraged)