umpirix/CONTRIBUTING.md
caelum0x c6c9901c6a feat(oss): GOVERNANCE.md, Scribase-family branding, MCP serverInfo/tools fixes
- Add GOVERNANCE.md (BDFL-style, referenced from CONTRIBUTING.md).
- Scribase family branding: "Umpirix — an open-source project by Scribase"
  header line in README (linking scribase.com and scribase.com/decisions),
  a "Run it on Scribase" section next to the self-host instructions in
  README and SELF-HOSTING.md (self-hosting stays fully supported, nothing
  gated), the same line appended to every package's npm/PyPI description
  (root, sdk/js, sdk/js-lite, sdk/ai-sdk, sdk/scribase-decisions, skills,
  adapters/python, sdk/python, otsone), and the site's per-page footer
  brand line (10 routes) + roadmap prose, which still said the pre-rebrand
  "OpenJev · Apache-2.0" - now "Umpirix · Apache-2.0 · scribase.com".
- Fix two real gaps in the MCP server found in a fresh clone: serverInfo
  still said name "openjev" / title "OpenJev typed decisions"
  (src/lib/jev/mcp.ts) and the stdio bridge's log prefix was still
  "[openjev mcp]" (scripts/mcp-stdio.mjs). Both now say Umpirix. Verified
  live over stdio (plain node; Docker/colima unavailable in this
  environment) that `initialize` reports serverInfo.name "umpirix" /
  title "Umpirix typed decisions", and `tools/list` returns the real tool
  set: choice, score, noul, decide (no "cascade").
- npm run typecheck / npm test (138/138) / npm run gold (61/61) / npm run
  lint (0 errors, pre-existing warnings only) all green after this change.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
2026-11-11 19:15:28 +03:00

2.9 KiB

Contributing to OpenJev

Thanks for your interest in OpenJev. Bug reports, fixes, new public datasets for the leaderboard, engine improvements, docs and SDKs for more languages are all welcome.

Before you start

  • For anything larger than a small fix, open an issue first so we can agree on the approach.
  • Security problems: do not open a public issue. Follow SECURITY.md.
  • By participating you agree to the Code of Conduct.

Development setup

Requirements: Node.js 22+, npm. Python 3.11+ and uv only if you work on otsone/, sdk/python/ or adapters/python/. Docker is optional.

git clone https://github.com/caelum0x/openjev && cd openjev
npm install
npm run embed-download      # optional: the gte-small model for the embedding engine
npm run dev                 # http://localhost:8080

No API keys, database or model weights are needed to run the server or the tests. Copy .env.example to .env only for the optional integrations it documents.

Checks to run before opening a pull request

Area you changed Command
server / console (src/) npm test && npm run gold && npm run typecheck && npm run lint
native engine (engine/) make -C engine
sdk/js cd sdk/js && npm install && npm test
sdk/js-lite cd sdk/js-lite && npm test
sdk/python cd sdk/python && uv sync && uv run pytest
adapters/python cd adapters/python && uv sync && uv run pytest
skills cd skills && npm test
otsone cd otsone && uv sync --extra dev && uv run pytest

If you change the engine's scoring, also run npm run leaderboard and include the before/after numbers in the pull request. Accuracy claims in docs must come from a reproducible run, never estimates.

Guidelines

  • Keep pull requests focused; one logical change per PR.
  • Add or update tests for behaviour changes.
  • Use Conventional Commits style messages (feat:, fix:, docs:, refactor:, test:, chore:, perf:).
  • Never commit secrets, .env files, model weights (*.onnx, *.safetensors, ...) or downloaded datasets; .gitignore covers the usual paths. See docs/WEIGHTS.md for how weights are fetched.
  • Code copied from other projects must be under a compatible license (Apache-2.0, MIT, BSD) and attributed in the relevant NOTICE file.

Licensing of contributions

Unless you state otherwise, contributions to Apache-2.0 parts of the repository are licensed under Apache-2.0, and contributions to the MIT-licensed directories (sdk/js, sdk/python, adapters/python, skills, sdk/scribase-decisions) under MIT, as described in section 5 of the Apache License. See NOTICE.

Governance

Decisions about this project are made as described in GOVERNANCE.md.