StevenicStevenic/vectra/.github/copilot-instructions.md

vectra

Copilot instructions633 starsChanged 7 months agoMITView on GitHub

A lightweight, file-backed vector database for Node.js and browsers with Pinecone-compatible filtering and hybrid BM25 search.

We split this copilot-instructions.md into the rules it gives an agent

4 rules. About 0 are common, 0 are distinctive, and 4 are very specific to this project.

≈0
Common · estimate
Many files like this have a rule of this kind.
≈0
Distinctive · estimate
This author's own choices. Worth a look.
4
Very specific
Tied to their project's names, files or tools. Probably skip.

Common
Distinctive
Very specific

Very specific:
Run npm run test:mocha for fast iteration (skips rebuild)
line 38
Very specific:
Run yarn lint and fix any errors
line 49
Very specific:
Run yarn test and ensure all tests pass
line 50
Very specific:
Update llms.txt if you changed public API surface
line 51

≈ “Common” is an estimate: at least 1 in 5 of the 3,669 Copilot instructions files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.

Files

copilot-instructions.md

Vectra

A lightweight, file-backed vector database for Node.js and browsers with Pinecone-compatible filtering and hybrid BM25 search.

Project Structure

src/ — TypeScript source files
lib/ — Compiled output (do not edit directly)
bin/ — CLI entry point (vectra)
docs/ — Jekyll documentation site (GitHub Pages via just-the-docs)
samples/ — Runnable example projects
dist/ — Browser bundle (do not edit directly)

Development Commands

yarn install — Install dependencies
yarn build or npm run build — Compile TypeScript + copy proto schemas and templates
yarn build:browser — Build browser UMD bundle via webpack
yarn build:all — Build both Node.js and browser targets
yarn test or npm test — Build + run tests
npm run test:mocha — Run tests only (skip build)
yarn lint or npm run lint — Run ESLint
yarn clean — Remove build artifacts

Code Conventions

TypeScript strict mode — no any unless unavoidable
Tests colocated with source: src/foo.spec.ts tests src/foo.ts
Barrel exports through src/index.ts — every public API must be re-exported here
Browser exports through src/browser.ts — excludes Node-specific modules
Internal utilities in src/internals/ — not exported from the package

Testing

Framework: mocha with sinon for mocks
Coverage: nyc — reports to Coveralls
Run npm run test:mocha for fast iteration (skips rebuild)
Test timeout: 10000ms

CI

GitHub Actions on push/PR to main
Pipeline: install → lint → build → test → coverage upload
Node 22 on ubuntu-latest

Before Submitting a PR

Run yarn lint and fix any errors
Run yarn test and ensure all tests pass
Update llms.txt if you changed public API surface

Download now (ZIP)

Where files are headingNew Copilot instructions files have more rules about branches and pull requests, and fewer about code style.
Of the Copilot instructions files we read, the 2,297 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.
In this repository3 other files it gives its agents.
- AGENTS.mdAGENTS.md
- CLAUDE.mdCLAUDE.md
- llms.txtllms.txt

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

Reviews can't be read right now.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free