Skip to content

docs: add comprehensive project documentation and development guidelines #21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 13, 2025

Conversation

dcramer
Copy link
Member

@dcramer dcramer commented Jul 13, 2025

Summary

  • Added comprehensive CLAUDE.md development guidelines with mandatory pre-development reading requirements
  • Created detailed documentation covering architecture, testing, development workflow, and scorer examples
  • Established clear code standards, validation checklists, and common implementation patterns

Test plan

  • Documentation files are properly formatted
  • All links and references are accurate
  • Code examples follow established patterns
  • Guidelines align with current codebase structure

🤖 Generated with Claude Code

Copy link

codecov bot commented Jul 13, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.50%. Comparing base (a9b1873) to head (09d75eb).
Report is 1 commits behind head on main.

✅ All tests successful. No failed tests found.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #21   +/-   ##
=======================================
  Coverage   84.50%   84.50%           
=======================================
  Files           4        4           
  Lines         400      400           
  Branches      115      115           
=======================================
  Hits          338      338           
  Misses         62       62           
Flag Coverage Δ
unittests 84.50% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

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

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

- Added blank lines before code blocks in architecture.md, development-guide.md, and testing.md
- Ensures proper markdown formatting for better readability
- Fixed package.json formatting via biome

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <[email protected]>
@dcramer dcramer requested a review from Copilot July 13, 2025 02:35
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

A comprehensive addition of project documentation, including development guidelines, architecture, testing standards, scorer examples, and provider transformations, plus minor package.json formatting cleanup.

  • Consolidated the files array in package.json into a single line.
  • Added detailed documentation covering testing requirements, development workflows, architecture overview, scorer patterns, provider transformations, and custom scorer examples.
  • Introduced a top-level CLAUDE.md with mandatory pre-development reading and repository guidelines.

Reviewed Changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
package.json Condensed the "files" array to a single-line format
docs/testing.md Added comprehensive testing standards and templates
docs/scorer-examples.md Provided multiple scorer implementation examples
docs/provider-transformations.md Documented tool call transformation patterns for various LLM providers
docs/development-guide.md Outlined setup, workflow, and scorer creation steps
docs/custom-scorers.md Showcased built-in and custom scorer usage examples
docs/architecture.md Described core architecture, data flow, and extension points
CLAUDE.md Introduced mandatory development guidelines and checklist
Comments suppressed due to low confidence (2)

docs/custom-scorers.md:20

  • [nitpick] Usage of ToolCallScorer() here is inconsistent with other examples that pass scorer functions directly (e.g., [ExactMatchScorer]). Standardize on one pattern (function reference vs invocation) to avoid confusion.
scorers: [ToolCallScorer()]

docs/testing.md:99

  • The example expects an error message of 'Missing required parameter', but elsewhere the thrown error is 'Expected value is required'. Update the test or error message to align examples with actual implementation.
  }).rejects.toThrow('Missing required parameter')

@dcramer dcramer merged commit 8e30078 into main Jul 13, 2025
9 checks passed
@dcramer dcramer deleted the claude-docs branch July 13, 2025 03:02
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.

1 participant