-
Notifications
You must be signed in to change notification settings - Fork 0
docs: polish open source project docs #13
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
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| --- | ||
| "@routerlab/core": patch | ||
| "@routerlab/cli": patch | ||
| --- | ||
|
|
||
| Polish the repository's open-source project documentation and contributor guidance. |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| ## Summary | ||
|
|
||
| - | ||
|
|
||
| ## Validation | ||
|
|
||
| - [ ] `bun run --filter '*' build` | ||
| - [ ] `bun test` | ||
| - [ ] `bun run eval:smoke` for routing or eval changes | ||
|
|
||
| ## Release | ||
|
|
||
| - [ ] Changeset added for user-visible package changes | ||
| - [ ] No release needed |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| # Code of Conduct | ||
|
|
||
| This project follows the Contributor Covenant Code of Conduct, version 2.1. | ||
|
|
||
| Contributors should keep discussion respectful, technical, and constructive. | ||
| Harassment, personal attacks, and repeated disruption are not acceptable. | ||
|
|
||
| Report conduct concerns to the maintainer listed in `package.json`. |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| # Contributing | ||
|
|
||
| Thanks for improving routerlab. This project is about transparent cost-quality | ||
| routing, so contributions should keep model selection explainable and | ||
| reproducible. | ||
|
|
||
| ## Development | ||
|
|
||
| ```bash | ||
| bun install --frozen-lockfile | ||
| bun run --filter '*' build | ||
| bun test | ||
| ``` | ||
|
|
||
| Run `bun run eval:smoke` for changes that affect routing or evaluation code. | ||
|
|
||
| ## Pull requests | ||
|
|
||
| - Keep changes focused on one routing, gateway, eval, CLI, or docs concern. | ||
| - Add tests for model selection, frontier, policy, or CLI behavior changes. | ||
| - Document user-facing behavior in the relevant README or `docs/`. | ||
| - Add a Changeset for package changes. | ||
|
|
||
| ## Evaluation changes | ||
|
|
||
| Changes to frontiers, task classes, or judge methodology should include enough | ||
| metadata for another contributor to reproduce the result. |
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| # Security Policy | ||
|
|
||
| ## Supported versions | ||
|
|
||
| Security fixes are applied to the latest published `@routerlab/*` packages. | ||
|
|
||
| ## Reporting a vulnerability | ||
|
|
||
| Use GitHub private vulnerability reporting for this repository, or contact the | ||
| maintainer listed in `package.json` if private reporting is unavailable. | ||
|
|
||
| Do not open a public issue for vulnerabilities involving API keys, prompt data, | ||
| gateway request handling, or CI/package-publishing credentials. | ||
|
|
||
| ## Security model | ||
|
|
||
| routerlab can sit in front of LLM API calls and may process prompts supplied by | ||
| applications. Keep credential handling explicit, avoid logging secrets, and | ||
| prefer opt-in persistence for prompts or provider responses. |
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| {"id":"tweet-fixture-0","input":{"text":"The new release is stable and noticeably faster."},"reference":"positive","metadata":{"label":"positive"}} | ||
| {"id":"tweet-fixture-1","input":{"text":"The command failed twice and the logs were unclear."},"reference":"negative","metadata":{"label":"negative"}} | ||
| {"id":"tweet-fixture-2","input":{"text":"The package installs and prints its help output."},"reference":"neutral","metadata":{"label":"neutral"}} |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| {"id":"squad-fixture-0","input":{"context":"RouterLab chooses among language models by comparing expected quality, latency, and token cost before making a call.","question":"What does RouterLab compare before making a call?"},"reference":{"goldAnswers":["expected quality, latency, and token cost"],"isImpossible":false}} | ||
| {"id":"squad-fixture-1","input":{"context":"The fixture dataset is intentionally tiny so smoke tests can run without downloading public benchmark slices.","question":"Why is the fixture dataset tiny?"},"reference":{"goldAnswers":["so smoke tests can run without downloading public benchmark slices"],"isImpossible":false}} | ||
| {"id":"squad-fixture-2","input":{"context":"RouterLab keeps cached evaluation examples under .cache/eval-datasets and does not commit generated cache files.","question":"Where are generated evaluation caches stored?"},"reference":{"goldAnswers":[".cache/eval-datasets"],"isImpossible":false}} |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
seedSmokeFixtures()writes fixture files todatasetCachePath(filename), which is the same cache location used by normalfrontier/frontier-alldataset loaders. After someone runsbun eval/cli.ts smoke, later non-smoke evals will read these tiny fixture caches instead of fetching the real HF datasets, silently producing incorrect frontier/quality results until the cache is manually cleared.Useful? React with 👍 / 👎.