Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR updates the README for the Codacy CLI v2 by refining the text, organizing sections, and standardizing commands.
- Updated title and introductory information
- Added detailed command usage, installation, and troubleshooting sections
- Clarified platform support and command examples
Coverage summary from CodacySee diff coverage on Codacy
Coverage variation details
Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: Diff coverage details
Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: See your quality gate settings Change summary preferences |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
inesgomas
approved these changes
May 27, 2025
andrzej-janczak
approved these changes
May 27, 2025
Contributor
andrzej-janczak
left a comment
andrzej-janczak
left a comment
There was a problem hiding this comment.
LGTM, just remember to squash please
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.
This pull request significantly updates the
README.mdfile for the Codacy CLI v2, improving its clarity, structure, and content. The changes include rebranding, adding badges, restructuring sections, introducing new commands, and providing detailed usage examples and troubleshooting tips.Documentation Improvements
README.mdto include clearer sections such as "Supported Platforms," "Installation," "CLI Commands," "Configuration," and "Troubleshooting."init,install,analyze,upload,update,version), including examples and flag descriptions.