docs: fix typos, grammar, and formatting across markdown files#408
Merged
stefanzweifel merged 2 commits intoMay 7, 2026
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR focuses on improving the project’s Markdown documentation by correcting typos/grammar, fixing formatting issues, and aligning examples with actual GitHub Actions configuration expectations.
Changes:
- Corrected the README’s
contentspermission guidance towriteand cleaned up Markdown/YAML formatting (blank lines, trailing whitespace, admonition formatting). - Tweaked UPGRADING text for clarity/grammar around tagging options.
- Converted a raw URL in CODE_OF_CONDUCT into a descriptive Markdown link.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
README.md |
Fixes permission guidance and multiple formatting/typo issues in examples and prose. |
UPGRADING.md |
Clarifies tagging option wording and improves readability with spacing. |
CODE_OF_CONDUCT.md |
Replaces the FAQ raw URL with a descriptive Markdown link. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| # Optional. Creates a new tag and pushes it to remote without creating a commit. | ||
| # Optional. Creates a new tag and pushes it to remote without creating a commit. | ||
| # Skips dirty check and changed files. Must be used in combination with `tag` and `tagging_message`. |
Comment on lines
71
to
+75
| available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html | ||
|
|
||
| [homepage]: https://www.contributor-covenant.org | ||
|
|
||
| For answers to common questions about this code of conduct, see | ||
| https://www.contributor-covenant.org/faq | ||
| For answers to common questions about this code of conduct, see the [Contributor Covenant FAQ](https://www.contributor-covenant.org/faq). |
| Adding git-auto-commit to your Workflow only takes a couple lines of code. | ||
|
|
||
| 1. Set the `contents`-permission of the default GITHUB_TOKEN to `true`. (Required to push new commits to the repository) | ||
| 1. Set the `contents`-permission of the default GITHUB_TOKEN to `write`. (Required to push new commits to the repository) |
Owner
|
Thanks! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Fixes accumulated typos, grammatical errors, broken formatting, and raw URLs across the project's Markdown documentation. No behaviour, code, or configuration has been changed.
Changes
README.md
contentspermission example value fromtruetowrite(the code block already showed
write; the prose was inconsistent)meesage→message,worfklow→workflowit's token→its tokenthis Actions→this Actionactions/checkout@4→actions/checkout@v4## Troubleshootingand its first subsectionCODE_OF_CONDUCT.md
(
version 1.4andContributor Covenant FAQ)UPGRADING.md
option→options(two options are referenced; singular was incorrect)SECURITY.md
security related→security-related(compound adjective)Motivation
Stale documentation with incorrect examples or typos erodes reader trust and can cause real confusion — particularly the
contents: truevscontents: writeinconsistency, which could lead users to configure their workflows incorrectly.Impact
action.yml, scripts, or tests were modified.Testing
Documentation-only change. Verified by re-reading the rendered Markdown and confirming all modified strings are correct against the surrounding context and linked references.