Skip to content

Latest commit

 

History

History
57 lines (44 loc) · 1.47 KB

File metadata and controls

57 lines (44 loc) · 1.47 KB

Contributing to onUI

Thanks for contributing.

Setup

git clone https://github.com/onllm-dev/onUI.git
cd onUI
pnpm install
pnpm --filter @onui/extension build

Development Workflow

  1. Create a branch from main.
  2. Keep commits focused and small.
  3. Run local quality gates before opening a PR:
    pnpm check
  4. Optional but recommended: run coverage checks locally:
    pnpm test:coverage
  5. Open a pull request with clear reproduction and validation notes.

CI Quality Gates

  • Pull requests and pushes to main run .github/workflows/quality-gates.yml.
  • Required checks:
    • pnpm typecheck
    • pnpm test:all
    • pnpm build:all
    • pnpm test:coverage (with package coverage thresholds)
  • CI runs verification on Node 20 and Node 22.

Self-Hosted Staging Runner

  • The workflow also runs Verify (Self-Hosted Staging) on labels:
    • self-hosted, Linux, X64, staging, onui
  • For security, self-hosted execution is manual only (workflow_dispatch).
  • Pull requests and pushes run only on GitHub-hosted runners by default.
  • See docs/security/self-hosted-runner.md for the hardening baseline.

Commit Guidelines

  • Use clear Conventional Commit prefixes when possible (feat:, fix:, docs:, chore:).
  • Keep UI and runtime changes split when practical.

Reporting Bugs

Include:

  • URL tested
  • expected vs actual behavior
  • browser + extension version
  • screenshots or short screen recording when possible