← Back to issue list

build: add README.md by default

View original Github issue

Metadata

Project
charmcraft
Number
#487
Type
pull request
State
merged
Author
heitorPB
Labels
—
Created
Updated
Closed

Current evaluation

Merged PR #487 added README.md to default charm builds for CharmHub page content; merged as e313799b with implementation in 3f6fa1a3.

Resolution: closed resolved

Reason: The approved change was merged in commit e313799b, adding README.md to the default packed charm files so CharmHub can display its content.

Evaluated by: mr-cal-bot

No scores available.

Issue body

The README.md file is used by CharmHub to display the contents of the charm's page. This file should then be included by default.

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved Merged PR #487 added README.md to default charm builds for CharmHub page content; merged as e313799b with implementation in 3f6fa1a3.
stealth/space-bunny-alpha — closed resolved Merged PR #487 in commit e313799b, adding README.md by default to charm builds so CharmHub can display charm-page content.
stealth/space-bunny-alpha — closed resolved Merged PR #487 (commit e313799b, change in 3f6fa1a3) so charm builds include README.md by default, letting CharmHub render the charm page from that file.
stealth/space-bunny-alpha — closed resolved Merged PR #487 in commit e313799b to include README.md by default when building charms, enabling CharmHub to display the charm-page content.
stealth/space-bunny-alpha — closed resolved Merged PR #487 in commit e313799b, adding README.md to Charmcraft's default build configuration so CharmHub can display charm pages.
stealth/space-bunny-alpha — closed resolved Merged #487 (commit e313799b), adding README.md to default builds so CharmHub can display the charm page.
qwen/qwen3.6-35b-a3b — — Merged. Adds README.md to the default build configuration to satisfy CharmHub requirements. Approved by two reviewers and finalized after the contributor signed the CLA.
qwen3.6-35b-a3b-mtp-q6 — — Merged. Adds README.md to the default build output for CharmHub display. After the contributor signed the CLA, the changes were approved and merged.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#471 config: add charm part to documentation (CRAFT-356) charmcraft merged Merged PR #471 via commit e0b18661, documenting the charm part in the configuration schema for CRAFT-356.
71%
#88 docs: add docstrings for the charm build planner craft-platforms merged Merged PR #88, commit 6becdf6, documenting the charm build planner and expanding the README; it fixes #75.
70%