Skip to content

Docs: Fix spelling mistakes #50

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Apr 12, 2020
Merged

Docs: Fix spelling mistakes #50

merged 3 commits into from
Apr 12, 2020

Conversation

yanyi
Copy link
Contributor

@yanyi yanyi commented Apr 12, 2020

Overview

I was using the repository and noted some spelling mistakes. This PR aims to fix them. Particularly, in the README.md and CONTRIBUTING.md files.

README.md

'reuse' instead of 'resuse':

-as it maximizes the resuse value of your workflow for non-tag pushes.
+as it maximizes the reuse value of your workflow for non-tag pushes.

Remove stutter of "can can":

-You can can configure a number of options for your
+You can configure a number of options for your

Capitalize 'Docker':

-> **⚠️ Note:** This action was previously implemented as a docker container, limiting its use to GitHub Actions Linux virtual environments only. With recent releases, we now support cross platform usage. You'll need to remove the `docker://` prefix in these versions
+> **⚠️ Note:** This action was previously implemented as a Docker container, limiting its use to GitHub Actions Linux virtual environments only. With recent releases, we now support cross platform usage. You'll need to remove the `docker://` prefix in these versions

Rename 'OSX' to 'macOS':

-   A GitHub Action for creating GitHub Releases on Linux, Windows, and OSX virtual environments
+   A GitHub Action for creating GitHub Releases on Linux, Windows, and macOS virtual environments

CONTRIBUTING.md

Additional space removed:

-This a [JavaScript](https://help.github.com/en/articles/about-actions#types-of-actions)  action but uses [TypeScript](https://www.typescriptlang.org/docs/home.html) to generate that JavaScript.
+This a [JavaScript](https://help.github.com/en/articles/about-actions#types-of-actions) action but uses [TypeScript](https://www.typescriptlang.org/docs/home.html) to generate that JavaScript.

End sentences with period:

-Tests can be found under under `__tests__` directory and are runnable with the `npm t` command
+Tests can be found under under `__tests__` directory and are runnable with the `npm t` command.

-A minimal attempt at keeping a consistent code style is can be applied by running `npm run fmt`
-
+A minimal attempt at keeping a consistent code style is can be applied by running `npm run fmt`.

Let me know what you think of these changes!

@softprops
Copy link
Owner

Thanks @yanyi!

@softprops softprops merged commit 9a89d1e into softprops:master Apr 12, 2020
@yanyi yanyi deleted the docs-fixes branch April 12, 2020 04:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants