← Back to issue list

Provide internal documentation for templates

View original Github issue

Metadata

Project
charmcraft
Number
#1964
Type
issue
State
open
Author
lengau
Labels
Created
Updated
Closed

Current evaluation

Internal task to add explanatory comments in charmcraft templates for ignored linter rules, originating from PR #1941 review. Open 684 days with no maintainer activity beyond a Jira ticket sync.

Suggested action: close stale

Reason: The issue is 684 days old with last activity 381 days ago (only the Jira bot comment). The templates have been extensively refactored since PR #1941 (uv, Jubilant, ruff updates in #2312, #2430, #2623, #2754, etc.), so the original linter-ignore context from the flake8/pydocstyle-to-ruff migration is largely obsolete. No maintainer has engaged beyond the auto-created Jira ticket, and the task is low-priority internal documentation with minimal impact.

Impact: 10 Quick Win: 9.0 Staleness: 75 Complexity: 10 Confidence: 70 Support Request: 0

Issue body

### What needs to get done Write comments on templates explaining why certain linters are ignored, etc. ### Why it needs to get done https://github.com/canonical/charmcraft/pull/1941#discussion_r1795470363

Evaluation history

Date Model Scores Action Summary
qwen/qwen3.8-27b
Impact: 10
Quick Win: 9.0
Staleness: 75
Complexity: 10
Confidence: 70
Support Request: 0
close stale Internal task to add explanatory comments in charmcraft templates for ignored linter rules, originating from PR #1941 review. Open 684 days with no maintainer activity beyond a Jira ticket sync.
qwen/qwen3.6-35b-a3b
Staleness: 90
Complexity: 10
Confidence: 80
Support Request: 5
needs triage Request to add internal documentation and comments to templates explaining linter configurations and design decisions. Currently unlabelled and inactive for over a year.
qwen3.6-35b-a3b-mtp-q6
Staleness: 85
Complexity: 10
Confidence: 70
Support Request: 0
needs triage Task to add internal comments to templates explaining linter ignores. Unlabelled and unassessed by maintainers, with only an automated Jira sync comment. Inactive for over 10 months.
qwen3.6-35b-a3b-mtp-q6
Staleness: 85
Complexity: 15
Confidence: 80
Support Request: 5
needs triage Request to add internal comments to templates explaining linter configurations and design decisions. Currently inactive with no labels or maintainer triage after over a year.
qwen3.6-35b-a3b-mtp-q6
Staleness: 70
Complexity: 10
Confidence: 75
Support Request: 5
needs triage Add inline comments to templates explaining linter ignores and configuration choices. Currently open and awaiting implementation, with an internal Jira ticket created. Last active over 300 days ago.

Update history

No update history recorded yet.

Related work

  • Caused By: canonical/charmcraft#1941 (confidence 90%)

    Issue body explicitly references PR #1941 discussion r1795470363 as the origin of this task.

Related issues

Issue Project State Summary Similarity
#2213 Change templates to link to current documentation charmcraft open Charmcraft templates should link charmcraft.yaml to modern docs instead of outdated juju.is pages. No comments or labels; recent template commits show active maintenance, so it needs triage.
71%