docs: update Claude docs from PR review analysis#360
Conversation
…04-08) Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…04-13) Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Doc files should be self-contained guidance, not a changelog. Removes (Source: PR #N) and @Reviewer references from the new rules/conventions introduced in this PR. Provenance stays in the PR description. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
![claude[bot]](https://avatars.githubusercontent.com/in/1236702?s=60&v=4){kind=small}
|
It took the suggestions from Open PRs as well. Did we not change the logic to consider only merged PRs after security team raised concern |
Sarath1018
left a comment
Sarath1018
left a comment
There was a problem hiding this comment.
Minor comments rest LGTM
Co-authored-by: Shreyash <ninja-shreyash@users.noreply.github.com>
This is because we raised this PR before the security concern. After that the workflow is already updated so this is not an issue. |
Move all coding anti-patterns (NEVER rules) from rules.md into conventions.md as inline annotations next to their related conventions. rules.md now only contains testing, documentation, and quality guidelines. - Add inline NEVERs to conventions.md only where they add non-obvious value (specific traps, unique why) — not mere inversions - Remove entire NEVER Do section from rules.md, rename to Testing & Quality - Fold unique test/docs NEVERs into their respective sections in rules.md - Update enhance-claude-docs skill to route anti-patterns to conventions.md - Move output/attachment indicator to Service model section per review feedback - Incorporate PR #360 new insights in correct locations Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
Review summaryOne new finding this run:
|
2 participants
Summary
Weekly analysis of PR comments (2026-04-06 -> 2026-04-13).
Analyzed 9 PRs with ~120 comments. Found 4 actionable insights across 2 runs.
Changes
agent_docs/conventions.md
Barrel files must use
export * from, notexport type * from—export typesilently drops runtime values (enums, class constructors).Source: PR Add Feedback service [PLT-92499] #184 (previous run)
Data Fabric exception to transform pipeline — Do NOT apply
pascalToCamelCaseKeys()or field-rename transforms to DF entity record fields. User-defined column names must be returned exactly as the API sends them — casing is part of the schema contract.Source: PR Remove camelCase conversion in DF methods [PLT-99360] #327 — @maninder-uipath raised concern about transforming DF fields; team removed transforms entirely to avoid breaking field-name contracts with DF consumers.
Include output/attachment indicator fields in response types — When an entity response can reference a file/attachment, include the key field (e.g.,
outputFileon Job) inRaw{Entity}GetResponseso callers know to call the output method.Source: PR feat(jobs): onboard getOutput method [PLT-100430] #320 — @swati354 noted that without
outputFileinJobGetResponse, users with emptyoutputArgumentswould have no signal that file output was available.agent_docs/rules.md
NEVER use internal product/team names in service file paths or class names — use the user-facing domain name (e.g.,
feedback.ts, notllmops.ts). Internal names leak org structure into the public API.Source: PR Add Feedback service [PLT-92499] #184 (previous run)
NEVER define static lookup tables inside method bodies — move to module-level constants. Static mappings rebuilt on every call waste memory and hide structure.
Source: PR feat(tasks): added GetTaskDataById API for DU-VS #323 (previous run)
NEVER apply camelCase or field-rename transforms to Data Fabric entity record fields — mirrors the conventions.md Data Fabric exception.
Source: PR Remove camelCase conversion in DF methods [PLT-99360] #327
No changes
CLAUDE.md— no relevant insightsAgents.md— no relevant insightsagent_docs/architecture.md— no relevant insightsPRs Analyzed