docs: add additional info to readme
Metadata
Current evaluation
Merged in craft-providers#81 via commit 554e87d (merge 1290a23), expanding the README with test, dependency-freezing, documentation, and commit-message guidance.
Resolution: closed resolved
Reason: PR #81 was approved and merged as commit 1290a23, with its README changes committed as 554e87d. The documentation additions were successfully incorporated.
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 in craft-providers#81 via commit 554e87d (merge 1290a23), expanding the README with test, dependency-freezing, documentation, and commit-message guidance. | |
| qwen/qwen3.6-35b-a3b | — | closed resolved | Merged PR adding instructions for running tests, freezing requirements, generating docs, and commit guidelines to the README. |
Update history
| Date | Change |
|---|---|
| created |
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #152 docs: add additional info to readme | craft-parts | merged | Merged #152, adding README instructions for tests, dependency freezing, local documentation generation, and commit-message guidelines; content commit 828c9543. | |
| #16 readme: document how to contribute and work with the project | craft-store | merged | Merged PR #16 via commit 51034f5, adding 58 lines of README guidance for contributing and working with craft-store. | |
| #224 readme: update readthedocs link | craft-providers | merged | Merged PR #224 (commit 7dcd9c9) updated the Read the Docs link in craft-providers' README.md. The 1-file, +1/-2 doc tweak was approved by a reviewer and released in 1.8.0. | |
| #675 docs(changelog): add 2.0.4 release notes | craft-providers | merged | Merged PR #675 via commit 48d6ec2, adding craft-providers 2.0.4 release notes after prerequisite #674 was merged. | |
| #103 docs: update package documentation (CRAFT-37) | craft-parts | merged | Merged #103 in commit ae6ca192, reorganizing package docs, adding an introductory usage tutorial and lifecycle/class diagrams, and improving docstrings. | |
| #49 Improved README and docs on how to use the lib (CRAFT-707). | craft-cli | merged | Merged in canonical/craft-cli#49 via d5f6567, improving the README and library usage documentation for CRAFT-707 across seven files. | |
| #773 docs: Release 2.4.0 | craft-providers | merged | Merged the craft-providers 2.4.0 release documentation in commit b45b740 through PR #773. | |
| #41 requirements: update dependencies | rockcraft | merged | Merged PR #41 in commit 0e8a4f5f; dependency updates included craft-providers 1.3.0 and were intended to address #39. | |
| #114 docs: update readme information | debcraft | merged | Merged canonical/debcraft#114 (commit 9aa2f55, DEBCRAFT-25): README gained a 'Basic usage' section documenting debcraft init and debcraft pack, styled like other Craft tools; +27/-7 lines, one file. | |
| #438 docs(changelog): add 1.19.1 release notes | craft-providers | merged | Merged PR #438 as commit 2c4bf34, adding craft-providers 1.19.1 release notes dated 2023-10-26. |