Skip to content

Conversation

@KatherineInCode
Copy link
Contributor

📔 Objective

This updates CLAUDE.md to also exclude mocks from the DocC requirements. We historically have not required documentation comments on these, because they are already documented in the original protocol, and they exist as mocks. Claude otherwise consistently generates comments on code review suggesting to document mocks, which ends up being noise.

⏰ Reminders before review

  • Contributor guidelines followed
  • All formatters and local linters executed and passed
  • Written new unit and / or integration tests where applicable
  • Protected functional changes with optionality (feature flags)
  • Used internationalization (i18n) for all UI strings
  • CI builds passed
  • Communicated to DevOps any deployment requirements
  • Updated any necessary documentation (Confluence, contributing docs) or informed the documentation team

🦮 Reviewer guidelines

  • 👍 (:+1:) or similar for great changes
  • 📝 (:memo:) or ℹ️ (:information_source:) for notes or general info
  • ❓ (:question:) for questions
  • 🤔 (:thinking:) or 💭 (:thought_balloon:) for more open inquiry that's not quite a confirmed issue and could potentially benefit from discussion
  • 🎨 (:art:) for suggestions / improvements
  • ❌ (:x:) or ⚠️ (:warning:) for more significant problems or concerns needing attention
  • 🌱 (:seedling:) or ♻️ (:recycle:) for future improvements or indications of technical debt
  • ⛏ (:pick:) for minor or nitpick changes

@KatherineInCode KatherineInCode marked this pull request as ready for review November 6, 2025 15:10
@claude
Copy link

claude bot commented Nov 6, 2025

Claude finished @KatherineInCode's task —— View job


Code Review Complete

Tasks

  • Read the modified CLAUDE.md file
  • Review the changes comprehensively
  • Provide detailed feedback

Summary of Changes

This PR updates .claude/CLAUDE.md to explicitly exclude mocks from DocC documentation requirements. The changes were made across two commits:

  1. Initial commit (3ee6984) added the mock exclusion using "As well"
  2. Follow-up commit (b40c75f) improved the wording to use "Additionally" and added consistency to the "During Implementation" section

Files changed: 1 file (.claude/CLAUDE.md)
Net changes: +2 lines, -2 lines


Critical Issues

None found. The changes are documentation-only and align with the stated objective.


Suggested Improvements

None. The changes are clear, concise, and achieve the stated goal of reducing noise in code reviews by explicitly documenting the existing practice of not requiring DocC comments on mocks.


Good Practices Observed


Action Items

None. This PR is ready to merge.


Review Notes

The changes successfully address the objective stated in the PR description. By explicitly documenting that mocks don't need DocC comments, this will prevent Claude from generating unnecessary code review comments suggesting documentation for mock implementations, which are already documented in their corresponding protocols.

The wording is clear and maintains consistency with the existing documentation style. The rationale provided ("because the docs for the public interface will be in the protocol") effectively explains why mocks are excluded from documentation requirements.

@github-actions
Copy link
Contributor

github-actions bot commented Nov 6, 2025

Logo
Checkmarx One – Scan Summary & Details426ac494-d842-4a87-a466-63ad3b532f54

Great job! No new security vulnerabilities introduced in this pull request

@codecov
Copy link

codecov bot commented Nov 6, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 83.68%. Comparing base (d26d553) to head (b40c75f).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2109      +/-   ##
==========================================
- Coverage   85.23%   83.68%   -1.55%     
==========================================
  Files        1709     1979     +270     
  Lines      145501   161307   +15806     
==========================================
+ Hits       124021   134995   +10974     
- Misses      21480    26312    +4832     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@KatherineInCode KatherineInCode enabled auto-merge (squash) November 6, 2025 16:16
@KatherineInCode KatherineInCode merged commit e030fbf into main Nov 6, 2025
16 checks passed
@KatherineInCode KatherineInCode deleted the katherine/mock-documentation branch November 6, 2025 16:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants