Skip to content

docs: update Claude docs from PR review analysis#380

Open
claude[bot] wants to merge 1 commit intomainfrom
claude-docs-update/2026-04-20
Open

docs: update Claude docs from PR review analysis#380
claude[bot] wants to merge 1 commit intomainfrom
claude-docs-update/2026-04-20

Conversation

@claude
Copy link
Copy Markdown
Contributor

@claude claude Bot commented Apr 20, 2026

Summary

Weekly analysis of PR comments (2026-04-13 -> 2026-04-20).
Analyzed 14 PRs with ~130 review comments. Found 4 actionable insights.

Changes

agent_docs/conventions.md

  • Extend "static lookup tables" hygiene rule to cover inline regex literals
    Source: PR feat(auth): add acr_values to OAuth authorization URL #364 — reviewer identified an inline GUID regex inside getAuthorizationUrl() that was recreated on every call. The existing rule only mentioned lookup tables; regex literals have the same issue.

  • Header constant naming: no _HEADER suffix in headers.ts
    Source: PR fix: add external user id header to http requests for cas #344 — reviewer noted that EXTERNAL_USER_ID_HEADER was inconsistent with all other constants in headers.ts (FOLDER_ID, FOLDER_KEY, USER_AGENT etc.) which don't have the suffix. Generalizes the existing endpoint-group naming rule ("context provides the prefix") to header constants.

agent_docs/rules.md

  • Never access private methods via as any in tests
    Source: PR feat(auth): add acr_values to OAuth authorization URL #364 — a test block used (service as any)._getAccessToken(...) to reach a private method. This violates both the no-any rule and creates brittle tests tied to implementation internals. Correct approach: test via public API or extract to a pure function.

  • Use let variable!: Type (definite assignment) for beforeAll-initialized test variables
    Source: PR fix: isolate attachment integration tests with per-run record creation [PLT-101734] #368 — reviewer preferred let recordId!: string over let recordId: string | undefined. The ! signals TypeScript that the value is guaranteed before tests run, eliminating null-checks throughout test bodies while keeping the afterAll guard working at runtime.

No changes

  • CLAUDE.md — no relevant insights found
  • Agents.md — no relevant insights found
  • agent_docs/architecture.md — no relevant insights found

PRs Analyzed

PR Title Comments
#378 docs: add Attachments scopes to Jobs.getOutput() 1 thread
#376 1.3.2 0 threads
#374 docs: shrink llms-full-content.txt 1 thread
#370 fix: enable Claude code review bot to approve clean PRs 0 threads
#364 feat(auth): add acr_values to OAuth authorization URL ~30 threads
#375 release: 1.3.1 0 threads
#344 fix: add external user id header to http requests for cas 9 threads
#352 Added DataFabric Sdk ~60 threads
#358 feat(jobs): add Jobs.getById method ~25 threads
#369 feat(data-fabric): add sdk Pagination support for Query Records 6 threads
#360 docs: update Claude docs from PR review analysis 4 threads
#368 fix: isolate attachment integration tests 2 threads
#366 ci: enhance claude code review and clean up enhance-claude-docs skill 0 threads
#291 feat(docs): update docs with coded app deployment ~45 threads

🤖 Generated with Claude Code

…04-20)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@claude claude Bot added the claude-docs-update Automated Claude docs enhancement label Apr 20, 2026
@claude claude Bot requested review from a team and ninja-shreyash April 20, 2026 09:37
@sonarqubecloud
Copy link
Copy Markdown

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

claude-docs-update Automated Claude docs enhancement

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants