[akshaylive]

Summary

• Add a ## Citation section to README.md with a @software BibTeX entry.
• Authors: Shanbhogue, Religa, Li, Balsells-Rodas, Ma. Organization: UiPath.
• No version field, because semantic-release bumps the version and a README copy would drift.

Test plan

• Doc lint tests (pytest -m lint tests/test_custom_lint.py) pass.

🤖 Generated with Claude Code

[uipreliga]

Review: coder_eval — pr:258 — "docs(readme): add a BibTeX citation" by @akshaylive · docs/readme-bibtex-citation → main · OPEN

Scope: pr:258 — "docs(readme): add a BibTeX citation" by @akshaylive · docs/readme-bibtex-citation → main · OPEN · branch docs/readme-bibtex-citation (pr-258) · 4bcdee0 · 2026-11-11T00:14Z · workflow variant

Change class: trivial — docs-only: adds a Citation section with a BibTeX block to README.md; no code, config or schema touched

PR 258 adds a docs-only Citation section to README.md with a valid biblatex @software entry whose URL and Apache-2.0 license match the repo, and it has no code, grading or harness effect; the only risks are small citation-metadata details (the author order differs from the PR body, a redundant publisher = {GitHub} field, and no CITATION.cff for GitHub's "Cite this repository" widget), so it is safe to merge after the author order is confirmed.

Summary

Axis	Score	🔴	🟠	🟡	🔵	Top Issue
1. Code Quality & Style	9.8 / 10	0	0	0	2	BibTeX author order does not match the order the PR states
2. Type Safety	10 / 10	0	0	0	0	—
3. Test Health	10 / 10	0	0	0	0	—
4. Security	10 / 10	0	0	0	0	—
5. Architecture & Design	10 / 10	0	0	0	0	—
6. Error Handling & Resilience	10 / 10	0	0	0	0	—
7. API Surface & Maintainability	9.9 / 10	0	0	0	1	README-only BibTeX does not populate GitHub's 'Cite this repository' widget; CITATION.cff is the conventional SSOT
8. Evaluation Harness Quality	10 / 10	0	0	0	0	—

Overall Score: 10 / 10 · Weakest Axis: Code Quality & Style at 9.8 / 10
Totals: 🔴 0 · 🟠 0 · 🟡 0 · 🔵 3 across 8 axes.

Blockers

None.

Non-blocking, but please consider before merge

None.

Nits

1. [Axis 1] BibTeX author order does not match the order the PR states (README.md:365) — The PR body states 'Authors: Shanbhogue, Religa, Li, Balsells-Rodas, Ma', but the entry has author = {Religa, Tomasz and Shanbhogue, Akshaya Vishnu Kudlu and Li, Bai and Balsells-Rodas, Carles and Ma, Tao},. Author order is the meaningful content of a citation, and anyone who copies this block inherits whichever order ships. Confirm the intended first author, then make the BibTeX line and the PR description agree (swap the first two names in the entry, or correct the PR body).
2. [Axis 1] Two overlapping fields name the issuing body: organization and publisher (README.md:369) — The entry sets both organization = {UiPath}, (line 368) and publisher = {GitHub}, (line 369). GitHub hosts the code. It does not publish it, and the url field already shows where the code lives. biblatex styles render both fields, so the output reads 'UiPath, GitHub'. Remove the publisher = {GitHub} line and keep organization = {UiPath} as the one issuer field. This is the smallest correct entry and leaves nothing redundant to keep in sync.
3. [Axis 7] README-only BibTeX does not populate GitHub's 'Cite this repository' widget; CITATION.cff is the conventional SSOT (README.md:364) — The new block @software{coder_eval, is the only citation metadata in the repo. git ls-tree -r pr-258 shows no CITATION.cff, codemeta.json or .zenodo.json. GitHub's sidebar 'Cite this repository' button, Zenodo and reference managers read CITATION.cff. They do not read README prose, so these tools show nothing for this repo. CITATION.cff is the conventional single source; GitHub generates BibTeX and APA from it. Recommended: add CITATION.cff with the same authors, title, url, license: Apache-2.0 and date-released, and leave out version for the same semantic-release drift reason that the PR gives. Then either keep the README block as a short copy or replace it with a one-line pointer to the sidebar widget. Do not add a lint guard for README/CFF parity; two small static copies do not justify a new rule. Optional and not blocking: @software is a biblatex type, so classic BibTeX .bst styles (plain, natbib/ACL) warn and fall back to misc. The license = {Apache-2.0} field is non-standard and the styles ignore it. CFF-to-BibTeX export has the same portability problem, so this is not a reason to change the entry type.

What's Missing

Parallel paths:

• 🔵 The PR adds citation metadata to README.md only. On pr-258 there is no CITATION.cff, codemeta.json or .zenodo.json, so GitHub's 'Cite this repository' widget, Zenodo and reference managers find no citation for this repo. Add CITATION.cff with the same authors, title, url, license (Apache-2.0) and date-released, and no version field. Keep the README block as a short copy of it or replace the block with a pointer to the widget. (trigger: README.md) (restates: Axis 7: README-only BibTeX does not populate GitHub's 'Cite this repository' widget; CITATION.cff is the conventional SSOT)
• 🔵 The new citation names five people as authors, but pyproject.toml (the PyPI metadata, which also uses README.md as its long_description) still says authors = [{ name = "UiPath", email = "coder-eval@uipath.com" }]. So the PyPI page shows 'UiPath' as author and, lower down, a citation that credits five named people. This can be intentional (organization for the package, people for the citation), but the PR does not say so. Either state the split in the PR, or make the two sources agree, for example by listing the people as authors in pyproject.toml or in a future CITATION.cff. (trigger: README.md)

Harness & Lint Improvements

Nothing identified.

Top 5 Priority Actions

1. Confirm who the first author is, then make README.md:365 (author = {Religa, Tomasz and Shanbhogue, ...}) and the PR description list the authors in the same order, because author order is the part of a citation that people copy.
2. Delete publisher = {GitHub}, at README.md:369 and keep organization = {UiPath} (README.md:368) as the only issuer field, so biblatex does not print 'UiPath, GitHub'.
3. Add a root CITATION.cff with the same authors, title, url, license: Apache-2.0 and date-released, and no version field because semantic-release would make it drift, so that GitHub's 'Cite this repository' widget, Zenodo and reference managers can find the citation that README.md:364 now gives only as prose.
4. After you add CITATION.cff, keep the README.md:364 BibTeX block as a short copy or change it to a one-line pointer to the sidebar widget, and do not add a lint rule to keep the two in sync.

---

Stats: 0 🔴 · 0 🟠 · 0 🟡 · 3 🔵 across 8 axes reviewed.

[uipreliga]

fix what you agree with and 🚢