docs: add additional info to readme
Metadata
Current evaluation
Merged #152, adding README instructions for tests, dependency freezing, local documentation generation, and commit-message guidelines; content commit 828c9543.
Resolution: closed resolved
Reason: PR #152 was approved and merged via merge commit d71712e8, delivering the README additions in commit 828c9543.
Evaluated by: mr-cal-bot
No scores available.
Issue body
Complement the README file with directions on how to run tests, freeze
requirements and generate documentation locally. General commit message
guidelines also added.
Co-authored-by: Sergio Schvezov <sergio.schvezov@canonical.com>
Signed-off-by: Claudio Matsuoka <claudio.matsuoka@canonical.com>
- [x] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)?
-----
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Merged #152, adding README instructions for tests, dependency freezing, local documentation generation, and commit-message guidelines; content commit 828c9543. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged canonical/craft-parts#152: README gained testing, dependency-freezing, local documentation and commit-message guidance; 61 lines added. | |
| qwen/qwen3.6-35b-a3b | — | — | Merged documentation update adding README instructions for running tests, freezing requirements, generating local documentation, and commit guidelines. Approved by one reviewer, passed CI checks, and added 61 lines to a single file. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation update to the README. Added instructions for running tests, freezing requirements, generating local documentation, and commit message guidelines. Co-authored by Sergio Schvezov. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #81 docs: add additional info to readme | craft-providers | merged | Merged in craft-providers#81 via commit 554e87d (merge 1290a23), expanding the README with test, dependency-freezing, documentation, and commit-message guidance. | |
| #387 docs: add readme template | starbase | merged | Merged PR #387 added a README template, landing as commit afc6663 after two approvals and with all listed CI checks passing. | |
| #669 Docs: Add build instructions to README | rockcraft | closed | README build instructions were addressed by merged PR #925 (commit 3d63a806), and the maintainer marked the request fixed. | |
| #258 docs: update readme and template, fix build error | starbase | merged | Merged PR #258 in commit 7d2790e, improving README and docs-preparation guidance and disabling PDF/EPUB generation to restore the documentation build. | |
| #1199 docs: update README according to template | craft-parts | merged | README documentation was updated to match the standard template; PR #1199 was merged via commit ef4d4fff. | |
| #14 update README.md to be more introductory | charmcraft | merged | Docs-only PR #14 merged via commit fa446930 (merge df14ae5c) from chipaca, rewriting README.md (+42/-1) to be more introductory. | |
| #10 docs: improve README | snapcraft-rocks | merged | Docs-only PR by maintainer tigarmo rewrote/improved README.rst (+66/-1). Approved by 2 reviewers and merged as squash commit cb40dd2 "docs: improve README (#10)". |