chore: reorganize evals/ into domain-based folder structure#33
Open
adnanrhussain wants to merge 5 commits intomainfrom
Open
chore: reorganize evals/ into domain-based folder structure#33adnanrhussain wants to merge 5 commits intomainfrom
adnanrhussain wants to merge 5 commits intomainfrom
Conversation
- Prompt .txt files → evals/literacy/qualitative-text-complexity/<evaluator>/ - Python notebooks and .py files → examples/ - Makefile, install.sh, run.sh, requirements.txt, .env.example → utils/ - Remove evals/prompts/ and Python package markers (__init__.py) - Add evals/math/ placeholder for future math evaluators
- Root README: update links and paths to new evals/literacy/ and utils/ locations - evals/README.md: simplify to a concise orientation guide, remove duplicated setup instructions
- Update release-please-config.json: rename package path to evals/, update component to evals, add last-release-sha anchor - Update .release-please-manifest.json: carry forward version 1.4.0 - Move CHANGELOG.md to evals/ root, add [Unreleased] entry for this restructure
Update relative imports in sdks/typescript/src/prompts/ from evals/prompts/ to evals/literacy/qualitative-text-complexity/
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
There was a problem hiding this comment.
Pull request overview
Reorganizes the evals/ directory into a domain-based taxonomy (starting with literacy → qualitative text complexity), and updates the TypeScript SDK + release automation to reference the new prompt locations.
Changes:
- Move evaluator prompt
.txtfiles intoevals/literacy/qualitative-text-complexity/**and add supporting READMEs/examples. - Update TypeScript SDK prompt import paths and test docs to use the new
evals/structure. - Migrate release-please component key from
evals/prompts→evalsand adjust CI workflow path filters for prompt changes.
Reviewed changes
Copilot reviewed 24 out of 53 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| sdks/typescript/tests/README.md | Updates local-dev test docs to point at new prompt folder path. |
| sdks/typescript/src/prompts/vocabulary/user.ts | Updates vocabulary user prompt import paths to new evals/ structure. |
| sdks/typescript/src/prompts/vocabulary/system.ts | Updates vocabulary system prompt import paths to new evals/ structure. |
| sdks/typescript/src/prompts/vocabulary/background-knowledge.ts | Updates background-knowledge prompt import path. |
| sdks/typescript/src/prompts/subject-matter-knowledge/index.ts | Updates SMK prompt import paths. |
| sdks/typescript/src/prompts/sentence-structure/complexity.ts | Updates sentence-structure complexity prompt + rubric import paths. |
| sdks/typescript/src/prompts/sentence-structure/analysis.ts | Updates sentence-structure analysis prompt import paths. |
| sdks/typescript/src/prompts/grade-level-appropriateness/index.ts | Updates GLA prompt import paths. |
| sdks/typescript/src/prompts/conventionality/index.ts | Updates conventionality prompt import paths. |
| release-please-config.json | Moves release-please package key to evals and adds last-release-sha. |
| .release-please-manifest.json | Renames manifest entry from evals/prompts to evals. |
| .github/workflows/test-sdk-typescript.yml | Adjusts workflow path filters to trigger on evals/**/*.txt. |
| evals/utils/run.sh | Adds a helper script to run the utils Makefile jupyter target. |
| evals/utils/install.sh | Adds a helper script to run the utils Makefile install target. |
| evals/utils/Makefile | Adds Makefile targets for venv setup, install, and launching Jupyter. |
| evals/utils/requirements.txt | Adds Python dependencies for evaluator notebooks/utilities. |
| evals/utils/.env.example | Adds example env file for API keys. |
| evals/math/README.md | Adds placeholder README for future math evaluators. |
| evals/README.md | Updates evals-level README to describe the new structure. |
| evals/CHANGELOG.md | Renames changelog header and documents the reorg under Unreleased. |
| evals/init.py | Removes package marker (shifts away from Python-package framing). |
| evals/prompts/init.py | Removes old prompts package marker. |
| evals/literacy/qualitative-text-complexity/README.md | Adds README describing prompt modules in the new QTC folder. |
| evals/literacy/qualitative-text-complexity/vocabulary/background-knowledge.txt | Adds/moves vocabulary background-knowledge prompt. |
| evals/literacy/qualitative-text-complexity/vocabulary/grades-3-4-system.txt | Adds/moves grades 3–4 vocab system prompt. |
| evals/literacy/qualitative-text-complexity/vocabulary/grades-3-4-user.txt | Adds/moves grades 3–4 vocab user prompt. |
| evals/literacy/qualitative-text-complexity/vocabulary/other-grades-system.txt | Adds/moves other-grades vocab system prompt. |
| evals/literacy/qualitative-text-complexity/vocabulary/other-grades-user.txt | Adds/moves other-grades vocab user prompt (with examples/rubric). |
| evals/literacy/qualitative-text-complexity/sentence-structure/analysis-system.txt | Adds/moves sentence-structure analysis system prompt. |
| evals/literacy/qualitative-text-complexity/sentence-structure/analysis-user.txt | Adds/moves sentence-structure analysis user prompt. |
| evals/literacy/qualitative-text-complexity/sentence-structure/complexity-system.txt | Adds/moves sentence-structure complexity system prompt. |
| evals/literacy/qualitative-text-complexity/sentence-structure/complexity-user.txt | Adds/moves sentence-structure complexity user prompt. |
| evals/literacy/qualitative-text-complexity/sentence-structure/rubric-grade-3.txt | Adds/moves grade 3 sentence-structure rubric. |
| evals/literacy/qualitative-text-complexity/sentence-structure/rubric-grade-4.txt | Adds/moves grade 4 sentence-structure rubric. |
| evals/literacy/qualitative-text-complexity/sentence-structure/rubric-grades-5-12.txt | Adds/moves grades 5–12 sentence-structure rubric. |
| evals/literacy/qualitative-text-complexity/grade-level-appropriateness/system.txt | Adds/moves GLA system prompt. |
| evals/literacy/qualitative-text-complexity/grade-level-appropriateness/user.txt | Adds/moves GLA user prompt. |
| evals/literacy/qualitative-text-complexity/subject-matter-knowledge/system.txt | Adds/moves SMK system prompt. |
| evals/literacy/qualitative-text-complexity/subject-matter-knowledge/user.txt | Adds/moves SMK user prompt. |
| evals/literacy/qualitative-text-complexity/conventionality/system.txt | Adds/moves conventionality system prompt. |
| evals/literacy/qualitative-text-complexity/conventionality/user.txt | Adds/moves conventionality user prompt. |
| evals/literacy/qualitative-text-complexity/examples/vocabulary_evaluator.ipynb | Updates notebook imports for new examples module layout. |
| evals/literacy/qualitative-text-complexity/examples/text_complexity_combo.ipynb | Updates notebook imports for new examples module layout. |
| evals/literacy/qualitative-text-complexity/examples/smk_evaluator.ipynb | Updates notebook imports for new examples module layout. |
| evals/literacy/qualitative-text-complexity/examples/sentence_structure_evaluator.ipynb | Updates notebook imports for new examples module layout. |
| evals/literacy/qualitative-text-complexity/examples/grade_level_evaluator.ipynb | Updates notebook imports for new examples module layout. |
| evals/literacy/qualitative-text-complexity/examples/conventionality_evaluator.ipynb | Updates notebook imports for new examples module layout. |
| evals/literacy/qualitative-text-complexity/examples/vocab_prompts.py | Adds Python prompt-module for vocab evaluator examples. |
| evals/literacy/qualitative-text-complexity/examples/smk_prompts.py | Adds Python prompt-module for SMK evaluator examples. |
| evals/literacy/qualitative-text-complexity/examples/sent_str_prompts.py | Adds Python prompt-module for sentence-structure evaluator examples. |
| evals/literacy/qualitative-text-complexity/examples/gla_prompts.py | Adds Python prompt-module for GLA evaluator examples. |
| evals/literacy/qualitative-text-complexity/examples/conventionality_prompts.py | Adds Python prompt-module for conventionality evaluator examples. |
| README.md | Updates root docs to point at new evals paths and requirements file location. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Reorganizes the
evals/folder from a flat, Python-centric structure into a scalable, language-agnostic domain taxonomy. This is a structural change only — no prompt content was modified.New structure:
📂 View branch
Commits
TODO
Before merging — push the release-please anchor tag:
Without this, release-please treats
evalsas a brand new component and may walk the full commit history on the next release.After the first release PR under the new
evalscomponent merges — removelast-release-shafromrelease-please-config.jsonin a follow-up commit. If left in, it permanently anchors all future releases to the same SHA.