docs: Add meta description guidelines to CONTRIBUTING.md
Metadata
Current evaluation
Closed unmerged after 203 days of inactivity. PR #1188 later added the metadata-description requirement to the PR checklist instead of CONTRIBUTING.md.
Resolution: closed stale
Reason: No merge commit or recorded resolution was found, and the repository history contains no change from PR #1115. The related work was addressed separately by merged PR #1188 in commit 51a62cea.
Evaluated by: mr-cal-bot
No scores available.
Issue body
All new pages in the documentation must now include metadata descriptions.
This pull request updates the `CONTRIBUTING.md` to add documentation guidelines for setting custom meta descriptions on new pages. It introduces instructions and best practices for writing effective meta descriptions.
---
- [x] I've followed the [contribution guidelines](https://github.com/canonical/rockcraft/blob/main/CONTRIBUTING.md).
- [x] I've signed the [CLA](http://www.ubuntu.com/legal/contributors/).
- [ ] I've successfully run `make lint && make test`.
- [x] I've added or updated any relevant documentation.
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed stale | Closed unmerged after 203 days of inactivity. PR #1188 later added the metadata-description requirement to the PR checklist instead of CONTRIBUTING.md. | |
| stealth/space-bunny-alpha | — | closed stale | Closed without a recorded resolution after 203 days without activity. Later PR #1188 (51a62cea) added a related meta-description checklist item, but not the proposed CONTRIBUTING.md guidance. | |
| stealth/space-bunny-alpha | — | closed stale | PR #1115 proposed meta-description guidelines in CONTRIBUTING.md but was closed unmerged, leaving review pending and snap-build failing. | |
| qwen/qwen3.6-35b-a3b | — | — | Documentation updates for meta description guidelines were closed without merging. Review remained pending and a snap-build CI check failed, resulting in abandonment. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Abandoned after maintainer feedback. Documentation guidelines for meta descriptions were not merged. |
Update history
No update history recorded yet.
Related work
-
Superseded By:
canonical/rockcraft#1188
(confidence 82%)
Added a meta-description requirement to the PR checklist, but did not implement the proposed CONTRIBUTING.md guidance.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #144 docs: update meta description guidelines | starflow | merged | Merged PR #144 updated meta description guidance and examples to the documentation team’s latest guidelines. | |
| #6181 chore: add doc meta description to pr checklist | snapcraft | merged | Merged PR #6181 in commit c4a774047, adding a one-line PR checklist requirement for documentation meta descriptions. | |
| #319 chore: add doc meta description to pr checklist | imagecraft | merged | Merged PR #319 added a PR-checklist item requiring documentation meta descriptions; landed in commit 8c361be. | |
| #1188 chore: add doc meta description to pr checklist | rockcraft | merged | Merged PR #1188 added a PR-checklist requirement for documentation meta descriptions; commit 51a62cea updated .github/PULL_REQUEST_TEMPLATE.md. |