Skip to content

docs: fix spelling, formatting, and accuracy issues in README#834

Open
kranthipoturaju wants to merge 1 commit intowagoid:masterfrom
kranthipoturaju:docs/fix-readme-quality
Open

docs: fix spelling, formatting, and accuracy issues in README#834
kranthipoturaju wants to merge 1 commit intowagoid:masterfrom
kranthipoturaju:docs/fix-readme-quality

Conversation

@kranthipoturaju
Copy link
Copy Markdown

@kranthipoturaju kranthipoturaju commented Apr 29, 2026

Improves the README to production quality by addressing spelling, grammar, formatting consistency, Markdown syntax, and documentation accuracy.

Changes

Correctness

  • Fix GithubGitHub in the document title
  • Align configFile default (./commitlint.config.mjs) with action.yml
  • Rewrite failOnErrors description, which previously described false
    behavior while the default is true
  • Update stale GitHub token docs URL
  • Remove trailing commas from the JSON output example (invalid JSON)

Formatting & Markdown

  • Remove trailing colon from #### Important Note: heading
  • Normalize all default: labels to Default: for consistency
  • Change JSON code fence language identifier to lowercase json
  • Wrap merge_group and pull_request event names in backticks in prose
  • Promote the config file note to bold (**Note:**) and add missing period
  • Fix Docker link text (removed spurious backtick inside link label)

Prose

  • Replace "env var" with "environment variable"
  • Replace "In order to do so, …" with "To do so, …"
  • Replace "Apart from" with "In addition to"
  • Minor wording improvements throughout

Copilot AI review requested due to automatic review settings April 29, 2026 18:49
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates the repository README to improve documentation correctness and presentation quality for the Commitlint GitHub Action.

Changes:

  • Fixes naming/formatting issues (e.g., “GitHub”, headings, Markdown code fences, valid JSON example output).
  • Aligns/clarifies several input descriptions and defaults (e.g., configFile, failOnErrors) and improves prose consistency.
  • Updates guidance around merge queue usage and related workflow examples.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

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