Provide internal documentation for templates
Metadata
Current evaluation
Maintainer task to add comments in charmcraft templates explaining why certain linters are ignored, following PR #1941 discussion. Still open with an internal Jira ticket (CRAFT-3571).
Suggested action: keep open
Reason: The issue is a valid, maintainer-authored documentation task referencing a specific PR discussion (#1941) and has an internal Jira ticket (CRAFT-3571), indicating it has been triaged. Current templates still contain unexplained lint.ignore lists (e.g. D105, D107 in pyproject.toml.j2), so the work remains relevant and unaddressed.
Evaluated by: mr-cal-bot
Issue body
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| ~deepseek/deepseek-pro-latest |
Impact:
20
Quick Win:
12
Complexity:
15
Confidence:
75
Actionability:
70
|
keep open | Maintainer task to add comments in charmcraft templates explaining why certain linters are ignored, following PR #1941 discussion. Still open with an internal Jira ticket (CRAFT-3571). | |
| qwen/qwen3.6-35b-a3b |
Impact:
20
Quick Win:
14
Complexity:
10
Confidence:
60
Actionability:
80
|
needs triage | Add internal documentation comments to templates explaining linter ignores, raised in PR #1941 discussion | |
| qwen/qwen3.8-27b |
Impact:
10
Quick Win:
9
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. |
Update history
No update history recorded yet.
Related work
-
Related To:
charmcraft#1941
(confidence 90%)
The issue explicitly links to PR #1941, which replaced flake8/pydocstyle with ruff in templates and prompted the request for explanatory comments.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #1851 How-to doc for charmcraft test | charmcraft | open | Documentation request from a maintainer to write a how-to guide for the undocumented `charmcraft test` command. Open with no labels, assignee, or maintainer triage; only an automated Jira-sync bot comment (CRAFT-3957). |