docs: add additional info to readme
Metadata
Current evaluation
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.
Suggested action: —
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 |
|---|---|---|---|---|
| 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 |
|---|---|---|---|---|
| #10 docs: improve README | snapcraft-rocks | merged | Merged documentation update improving the README. Approved by two reviewers, adding 66 lines and removing one across a single file. | |
| #387 docs: add readme template | starbase | merged | Merged after approval by two reviewers and successful CI checks. The pull request introduced a README template, adding 73 lines and removing 7 across two files to standardize project documentation. | |
| #294 docs: add CONTRIBUTING.md | craft-store | merged | Merged addition of CONTRIBUTING.md documentation. Approved by two reviewers and passed most CI checks. Minor discussions about local integration test instructions were noted but did not block the merge. | |
| #258 docs: update readme and template, fix build error | starbase | merged | Merged after two reviewer approvals and passing CI. Updated README wording, added doc preparation details, and disabled PDF and EPUB generation to resolve build errors. All changes passed tests with 100% coverage. | |
| #331 docs: fix spacing errors in README | starbase | merged | Merged documentation changes fixing missing newlines in the README that prevented proper markdown ordered sub-list rendering. Approved by two reviewers, passed CI, and applied with a +5/-0 line change. | |
| #920 docs: add 'about this documentation' | rockcraft | merged | Merged documentation update adding an 'about this documentation' section. Approved by two reviewers, passed CI checks, and introduced 86 lines across three files. | |
| #263 docs: local testing howto | fetch-service | merged | Merged documentation update adding a local testing how-to guide. Approved by two reviewers, the PR adds 54 lines across two files to document testing workflows. | |
| #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. | |
| #1052 docs: Update README.md contributing link | rockcraft | merged | Merged a documentation update fixing a broken contributing link in README.md to point to CONTRIBUTING.md. Approved by three reviewers, passed CI checks, and applied as a single-line change. | |
| #478 docs: update changelog | fetch-service | merged | Merged changelog update. Approved by two reviewers with all CI checks passing. The commit added seven lines to a single documentation file. |