arkade
arkade copied to clipboard
Fixed grammatical errors in README.md
Description
Fixed 39 issues in README.md which include spelling mistakes and grammatical errors.
Motivation and Context
This change is required to provide a more clear, lucid, and user-friendly README.md
- [x] I have raised an issue to propose this change, which has been given a label of
design/approved
by a maintainer (required)
How Has This Been Tested?
If updating or adding a new CLI to arkade get
, run:
go build && ./hack/test-tool.sh TOOL_NAME
Types of changes
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
Documentation
- [ ] I have updated the list of tools in README.md if (required) with
./arkade get --format markdown
- [ ] I have updated the list of apps in README.md if (required) with
./arkade install --help
Checklist:
- [x] My code follows the code style of this project.
- [ ] My change requires a change to the documentation.
- [x] I have updated the documentation accordingly.
- [x] I've read the CONTRIBUTION guide
- [x] I have signed-off my commits with
git commit -s
- [ ] I have tested this on arm, or have added code to prevent deployment
Thank you for your contribution. It seems that one or more of your commits have a "Signed-off-by" statement with an anonymous email address. The Developer Certificate of Origin (DCO) requires all commits to be signed off by genuine, contactable individuals. Please see our contributing guide.
### :bulb: Shall we fix this?
This will only take a few moments.
First, clone your fork and checkout this branch using the git CLI.
Next, set up your real name and email address:
git config --global user.name "Your Full Name"
git config --global user.email "[email protected]"
Finally, run one of these commands to add the "Signed-off-by" line to your commits.
If you only have one commit so far then run: git commit --amend --signoff
and then git push --force
.
If you have multiple commits, watch this video.
Check that the message has been added properly by running "git log".
Hi, this looks like it might have been generated by an automated tool, parts of the output you want to change are auto-generated from upstream projects, so cannot be changed.
I'll take a look over this and cherry pick what I think is worth changing.
FYI, sign-offs need a proper email address, and a no-reply address won't pass checks.
Alex
/close: cherry-picked elsewhere as per https://github.com/alexellis/arkade/pull/990#issuecomment-1772738421
/lock: resolved