docs: fix spelling, formatting, and accuracy issues in README#834
Open
kranthipoturaju wants to merge 1 commit intowagoid:masterfrom
Open
docs: fix spelling, formatting, and accuracy issues in README#834kranthipoturaju wants to merge 1 commit intowagoid:masterfrom
kranthipoturaju wants to merge 1 commit intowagoid:masterfrom
Conversation
There was a problem hiding this comment.
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.
6fb478e to
c9d0638
Compare
There was a problem hiding this comment.
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.
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.
Improves the README to production quality by addressing spelling, grammar, formatting consistency, Markdown syntax, and documentation accuracy.
Changes
Correctness
Github→GitHubin the document titleconfigFiledefault (./commitlint.config.mjs) withaction.ymlfailOnErrorsdescription, which previously describedfalsebehavior while the default is
trueFormatting & Markdown
#### Important Note:headingdefault:labels toDefault:for consistencyJSONcode fence language identifier to lowercasejsonmerge_groupandpull_requestevent names in backticks in prose**Note:**) and add missing periodProse