← Back to issue list

docs: maintain project file terminology

View original Github issue

Metadata

Project
snapcraft
Number
#5256
Type
pull request
State
merged
Author
medubelko
Labels
Created
Updated
Closed

Current evaluation

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.

Suggested action:

No scores available.

Issue body

- Replace "snapcraft.yaml" with "project file" where appropriate. - Adjust code block indentation and language. - Add filename caption to snapcraft.yaml snippets. - Replace some instances of "keyword" with "key". - Fix name of example Java app. - [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/)? - [x] Have you successfully run `tox run -m lint`? -----

Evaluation history

Date Model Scores Action Summary
qwen/qwen3.6-35b-a3b 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.
qwen3.6-35b-a3b-mtp-q6 Merged documentation updates standardizing terminology to project file, fixing code formatting, and correcting an example app name. Approved by @mr-cal and merged after passing coverage checks, with unrelated test failures noted.
qwen3.6-35b-a3b-mtp-q6 Merged documentation updates standardizing terminology by replacing snapcraft.yaml with project file, fixing example names, and adjusting code formatting. Changes passed lint and coverage checks, then were approved and merged despite unrelated test failures.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#814 docs: maintain project file terminology rockcraft merged 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.
79%
#5466 docs: migrate 'snapcraft.yaml' snapcraft merged Merged documentation migration moving snapcraft.yaml build configuration content from snapcraft.io to ReadTheDocs. Content added to the project file index. Approved by two reviewers with all CI checks passing.
71%
#5924 docs: clean up 'snapcraft.yaml' snapcraft merged Merged documentation cleanup for snapcraft.yaml, including typo fixes, docstring link updates, and JSON schema regeneration. Reviewers approved the non-functional changes, and the schema workflow was resolved by running make schema.
71%