← Back to issue list

chore: clarify that tasks can be used for documentation requests too

View original Github issue

Metadata

Project
snapcraft
Number
#5520
Type
pull request
State
merged
Author
bepri
Labels
Created
Updated
Closed

Current evaluation

Merged a one-line documentation update clarifying that the task category supports documentation requests. Approved by two reviewers and merged despite one failing CI test.

Suggested action:

No scores available.

Issue body

- [x] Have you followed the [guidelines for contributing](https://github.com/canonical/snapcraft/blob/main/CONTRIBUTING.md)? - [x] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)? - [ ] Have you successfully run `make lint`? - [ ] Have you successfully run `make test`? --- Comes from a suggestion by @farshidtz in https://github.com/canonical/snapcraft/issues/5511. After some discussion with @mr-cal, it was decided that the "task" category's headers were fine for documentation changes, but it needed to be more explicit that that was an intended usage.

Evaluation history

Date Model Scores Action Summary
qwen/qwen3.6-35b-a3b Merged a one-line documentation update clarifying that the task category supports documentation requests. Approved by two reviewers and merged despite one failing CI test.
qwen3.6-35b-a3b-mtp-q6 Merged a documentation clarification stating that the tasks category can be used for documentation requests. The change explicitly defines this intended usage following community feedback and maintainer review.
qwen3.6-35b-a3b-mtp-q6 Merged a documentation update to explicitly clarify that the task category in contribution guidelines can be used for documentation requests, following a suggestion from issue 5511.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#702 chore: fix docs spelling issues craft-parts merged Merged documentation corrections that fixed spelling errors across two files. Approved by two reviewers and passed CI, the changes were successfully integrated.
77%
#1188 chore: add doc meta description to pr checklist rockcraft merged Merged a chore updating the pull request checklist to require a documentation meta description. Approved by two reviewers with all CI checks passing. The change modifies one file by adding two lines.
76%
#2651 chore: add doc meta description to pr checklist charmcraft merged Merged a maintainer PR adding a documentation meta description checklist item to the pull request template. Approved by two reviewers and passed all CI checks prior to integration.
75%
#463 chore: add documentation items to PR checklist starbase merged Merged after three approvals and passing all CI checks. Adds documentation policy items and a CONTRIBUTING.md link to the PR checklist. A suggestion to add HTML comments for checkbox instructions was declined to assume basic UI competency.
74%
#319 chore: add doc meta description to pr checklist imagecraft merged Merged a pull request adding a documentation meta description requirement to the PR checklist. The single-line change received two approvals, passed all CI checks, and was successfully integrated.
73%
#621 chore: update fileset and organize docstrings craft-parts merged Merged a chore pull request updating the fileset and organizing docstrings. Changes affected two files (+22/-9 lines). Approved by two reviewers, passed CI checks, and was successfully merged by the maintainer.
73%
#158 chore: update docstrings debcraft merged Merged updates to public function docstrings, adding missing parameters and return values. Approved by two reviewers, passed CI checks, and modified 10 files with 55 additions and 9 deletions.
73%
#773 chore: documentation polish craft-parts merged Documentation polish changes were approved by two reviewers, passed CI checks, and successfully merged. The update modified two files with 32 additions and 11 deletions.
71%
#521 chore: add doc meta description to pr checklist starbase merged Merged a one-line change adding a doc meta description item to the PR checklist. Approved by two reviewers and passed all CI checks. The maintainer plans to propagate this update to other applications.
71%
#529 chore: fix doc and yaml linting craft-parts merged Merged after two approvals and passing CI. Resolves documentation and YAML linting issues across three files. Net reduction of two lines. Local verification available via tox lint.
70%