cli: add what, why, and how to fix to the common errors
Metadata
Current evaluation
Merged pull request adding what, why, and how to fix guidance to common CLI error messages. Approved by two reviewers, modified 15 files (+484/-155 lines), and passed CI after a temporary test failure was rerun.
Suggested action: —
No scores available.
Issue body
- [x] Have you followed the [guidelines for contributing](https://github.com/snapcore/snapcraft/blob/master/CONTRIBUTING.md)?
- [x] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)?
- [x] If this is a bugfix. Have you checked that there is a bug report open for the issue you are trying to fix on [bug reports](https://bugs.launchpad.net/snapcraft)?
- [x] If this is a new feature. Have you discussed the design on the [forum](https://forum.snapcraft.io)?
- [x] Have you successfully run `./runtests.sh static`?
- [x] Have you successfully run `./runtests.sh unit`?
-----
First iteration over the suggestions by mpt.
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| qwen/qwen3.6-35b-a3b | — | — | Merged pull request adding what, why, and how to fix guidance to common CLI error messages. Approved by two reviewers, modified 15 files (+484/-155 lines), and passed CI after a temporary test failure was rerun. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged after addressing reviewer feedback and resolving transient test failures. The update enhances the CLI by adding what, why, and how-to-fix explanations to common error messages. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Added what, why, and how to fix guidance to common CLI errors. Merged after author reran tests following initial websocket closure failures. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #1790 cli: include consistent commands to fix error conditions | snapcraft | merged | Merged implementation of consistent CLI commands to resolve error conditions. Closes #1733, depends on #1640, and received reviewer approval with minimal code changes across three files. | |
| #1789 cli: improve the help command | snapcraft | merged | Improved the CLI help command to match --help parity and expose hidden topics and plugin help. Merged after reviewer approval and passing CI, modifying three files with 62 additions and 11 deletions. | |
| #1251 cli: remove empty lines in the unclean parts message | snapcraft | merged | Merged a change removing empty lines from the CLI unclean parts message to match UI formatting. Approved by one reviewer, updating two files with eight additions and eight deletions. | |
| #2521 cli: cleanup environment detection | snapcraft | merged | Merged cleanup of CLI environment detection. The pull request modified two files (+23/-21 lines), passed CI checks, and received approval. The refactoring was successfully integrated into the main branch despite a minor Codecov base commit warning. | |
| #3531 cli: warn and error messages to stderr (CRAFT-134) | snapcraft | merged | Merged after approval and passing CI checks. Redirects CLI warning and error messages to stderr, resolving CRAFT-134. Updates 7 files with 19 lines added and removed. | |
| #2429 cli: fix usage string in help command | snapcraft | merged | Merged a one-line fix that corrected an incorrect usage string in the CLI help command. The change was approved, passed CI checks, and resolved the reported bug. | |
| #84 fix(cli): enable per-command help queries | craft-application | merged | Merged to main, enabling per-command help queries in the CLI and resolving issue #76. Approved by two reviewers, passed CI checks, and achieved 100% diff coverage across three files. | |
| #1050 cli: add how to use exported credentials in help | charmcraft | merged | Merged updates to the CLI help text that document how to use exported credentials. Approved by one reviewer, the change adds 14 lines and removes 1 across a single file. |