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:
Details
When I first stumbled on the issue that led me to submit this PR, I read this repo's README and PR template, and also looked for a CONTRIBUTING file to make sure it wasn't a requirement to open an issue first. Not finding any obvious prerequisites, I proceeded to do the work and testing. It wasn't until after I finished, when I already had all my notes ready to go, and clicked the PR button that I realized I forgot to look at the PR template raw comments... which is where the Contributing guidance was hiding. So I'm hoping you will let me get away with skipping opening issues this one time and accept my PR with the cute picture sacrifice and additional payment of "fixing" the Contributing guidance so that hopefully other first time contributors don't have the same issue.- What I did
install.shwill not exit with error when supplied invalid arguments.install.shfor--helpargument.- How I did it
usagefunction called when invalid argument is provided toinstall.shand script exits WITH error.usagefunction with new supported--helpargument ininstall.shwhich will exit WITHOUT error.PULL_REQUEST_TEMPLATE.md.PULL_REQUEST_TEMPLATE.mdto the repoREADME.md.- How to verify it
1. Exit install.sh with usage and error on invalid argument
sh install.sh --invalidBEFORE:
Details
AFTER:
Details
2. Exit install.sh with usage and NO error on
--helpargumentsh install.sh --helpBEFORE (same as above):
Details
AFTER:
Details
Regression tests: install still works
sh install.sh --dry-runDetails
sh install.shDetails
Linted and tested locally
shellcheck:
Details
test:
Details
README Contributing section
Details
- 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)