docs: maintain project file terminology
Metadata
Current evaluation
Merged documentation update standardizing terminology by replacing recipe with project file and field with key. Adjusted code block formatting and added captions across 27 files. Approved and passed CI.
Suggested action: —
No scores available.
Issue body
- Replace "recipe" with "project file" where appropriate.
- Adjust indentation and language of some code blocks.
- Add filename caption to rockcraft.yaml snippets.
- Replace some instances of "field" with "key".
- [x] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)?
---
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| qwen/qwen3.6-35b-a3b | — | — | Merged documentation update standardizing terminology by replacing recipe with project file and field with key. Adjusted code block formatting and added captions across 27 files. Approved and passed CI. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation updates standardizing terminology by replacing recipe and field with project file and key. Adjusted code block indentation and added captions to rockcraft.yaml examples. Successfully merged by maintainer medubelko. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation updates standardizing terminology by replacing recipe with project file and field with key. Adjusted code block indentation, added captions to rockcraft.yaml snippets, and refined language for consistency. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #5256 docs: maintain project file terminology | snapcraft | merged | Documentation terminology standardized by replacing "snapcraft.yaml" with "project file" throughout the codebase. Changes include adjusted indentation, fixed example app names, and updated captions. Approved by reviewers, passed CI checks, and successfully merged. | |
| #2169 docs: replace "recipe" as a term | charmcraft | merged | Merged documentation update replacing the term recipe across seven files. Addresses leftover work from CRAFT-4000, approved by two reviewers, and incorporates lint fixes prior to final merge. | |
| #192 docs: update how-to project file to new features | imagecraft | merged | Merged documentation update to align the how-to project file with new features. Approved by two reviewers and passed CI checks despite a failing spread test. Changes modified two files with minor additions and deletions. | |
| #2154 docs: replace occurrences of "charmcraft.yaml" and "recipe" | charmcraft | merged | Merged documentation update replacing charmcraft.yaml and recipe with project or project file across 23 files. Approved by two reviewers after minor clarity feedback. Changes span +155/-159 lines. | |
| #1685 docs: replace keywords with keys | craft-parts | merged | Merged documentation update replacing keyword with key for consistent YAML terminology. Approved by two reviewers with all CI checks passing. Resolves issue 994 across 21 files. | |
| #6231 docs: incorporate tutorial feedback | snapcraft | merged | Merged documentation updates incorporating tutorial feedback from UXR and a TA. Approved by three reviewers and passed CI checks. Modified four files (+53/-72 lines) to refine project guides. | |
| #845 docs: document the `project.Project` model | craft-application | merged | Merged after two approvals and passing CI checks. Documents the project.Project model across six files, adding 166 lines and removing 17. Feedback was addressed by adding a dedicated docs file in the same commit. | |
| #103 docs: update package documentation (CRAFT-37) | craft-parts | merged | Merged documentation updates reorganizing the layout, improving docstrings, and adding lifecycle and class diagrams. Approved by two reviewers, passed CI, and changed 21 files (+511/-83). | |
| #354 docs: incorporate tutorial feedback | imagecraft | merged | Merged documentation updates incorporating tutorial feedback. Approved by a reviewer, passed all CI checks, and modified four files. Changes preempt updates in a related pull request. | |
| #826 docs: update CONTRIBUTING.md | craft-application | merged | Merged documentation update aligning CONTRIBUTING.md with the official template. Approved by three reviewers with all CI checks passing. The change modifies one file with 104 additions and 48 deletions. |