← Back to issue list

Small text cleanups for README and charmcraft help

View original Github issue

Metadata

Project
charmcraft
Number
#188
Type
pull request
State
merged
Author
markshuttle
Labels
Created
Updated
Closed

Current evaluation

Merged text cleanups for the README and charmcraft help documentation. Approved by two reviewers, the change updates 13 files to improve clarity while preserving test compatibility.

Suggested action:

No scores available.

Issue body

Lots of text work, I tried not to change anything that might break tests but the occasional %s might have slipped through :)

Evaluation history

Date Model Scores Action Summary
qwen/qwen3.6-35b-a3b Merged text cleanups for the README and charmcraft help documentation. Approved by two reviewers, the change updates 13 files to improve clarity while preserving test compatibility.
qwen3.6-35b-a3b-mtp-q6 Merged external contribution applying minor text cleanups to the README and charmcraft help documentation. Changes improved readability while preserving test compatibility.
qwen3.6-35b-a3b-mtp-q6 Merged external contribution updating README and charmcraft help text. Changes focused on documentation cleanup and minor phrasing improvements without affecting test functionality.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#2154 docs: replace occurrences of "charmcraft.yaml" and "recipe" charmcraft merged Merged documentation update replacing charmcraft.yaml and recipe with project or project file across 23 files. Approved by two reviewers after minor clarity feedback. Changes span +155/-159 lines.
79%
#471 config: add charm part to documentation (CRAFT-356) charmcraft merged Merged changes adding charm configuration documentation to the configuration schema. Approved by two reviewers with zero unresolved comments. Updated two files with 15 additions and one deletion. Resolves CRAFT-356.
77%
#2795 docs: improve `charmcraft clean` command documentation charmcraft closed Documentation improvements for the charmcraft clean command were rejected and closed after a reviewer criticized the changes as subpar. The pull request was not merged.
76%
#289 fix: fix issues found in common.mk with charmcraft starbase merged Merged a fix for charmcraft issues in common.mk. Approved by two reviewers with zero unresolved comments. Changed two files, adding 11 and removing 7 lines.
76%
#1622 fix: reorganise charmcraft.yaml preprocessing charmcraft merged Merged following two approvals and passing CI. Reorganized charmcraft.yaml preprocessing to apply extensions on raw data, assign default parts to charms with bases, and enforce dictionary type for parts. Modified 5 files (+27/-14 lines).
74%
#91 First pass at 'charmcraft init' charmcraft merged Merged the initial 'charmcraft init' implementation. Approved by two reviewers, the PR adds 1087 lines across 24 files to scaffold charms. README.md, additional options, and interactive prompts require future updates.
74%
#380 Charmcraft imported improvements starbase merged Merged minor import improvements for Charmcraft across two files. Approved by two reviewers and passed all CI checks before integration.
73%
#1357 refactor: reorganise constants charmcraft merged Merged a refactor reorganizing constants for Charmcraft environment variables, project filenames, and output files/directories across 47 files. Changes include 471 additions and 443 deletions. Approved by four reviewers with no unresolved comments.
73%
#46 New functionality from charmcraft (CRAFT-706). craft-cli merged Merged new charmcraft functionality (CRAFT-706) following approval from two reviewers. The update adds approximately 2000 lines across 13 files, successfully integrating the feature set into the codebase.
73%
#2010 docs: add, refactor, and reformat discourse docs feat. charmcraft charmcraft merged Merged documentation updates adding, refactoring, and reformatting Discourse content for Charmcraft into the ReadTheDocs project. Includes markdown to RST conversion, linter fixes, and structural improvements. Approved with noted future adjustments.
72%