Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
169 lines (117 loc) · 5.21 KB

CONTRIBUTING.md

File metadata and controls

169 lines (117 loc) · 5.21 KB

Contributing to OpenRouter Pipe

Thanks for wanting to contribute! This document is intentionally opinionated: it codifies the deliverable-PR playbook the maintainers use day-to-day so new contributors can ship changes with the same cadence and quality.

Table of Contents

Code of Conduct

This project follows the Contributor Covenant Code of Conduct. By participating, you agree to uphold this code.

Getting started

  1. Fork the repository on GitHub.

  2. Clone your fork locally:

    git clone https://github.com/<your-username>/Open-WebUI-Pipe-OpenRouter.git
cd Open-WebUI-Pipe-OpenRouter

  3. Install dependencies:

    pip install -r requirements.txt

  4. Verify the baseline is green before changing anything:

    python test_pipe.py

Development setup

Prerequisites

  • Python ≥ 3.10 (matches the CI matrix).
  • requests ≥ 2.20.
  • pydantic ≥ 2.0.

Useful commands

Command Description
python test_pipe.py Run the full unit test suite (252 tests)
python integration_test.py Run live API tests (requires OPENROUTER_API_KEY)

Deliverable-PR playbook

Every change is shipped as a single-deliverable pull request. One PR = one reviewable unit of value. The playbook:

  1. Sync main and create a branch with a descriptive slug:

    git checkout main && git pull
git checkout -b feat/<slug>

  2. Implement the smallest complete slice of the change. Prefer surgical edits over incidental refactors.

  3. Add or update tests. A change without test coverage needs a written justification in the PR body. The unit test suite must remain at 252/252.

  4. Validate locally using the same commands CI runs:

    python test_pipe.py
python integration_test.py   # optional, requires a valid API key

  5. Update CHANGELOG.md. Prepend a bullet under ## [Unreleased] describing the user-visible impact.

  6. Commit with Conventional Commits (see Commit messages) and push:

    git push -u origin feat/<slug>

  7. Open the pull request using the PR template and fill every section.

  8. Verify CI goes green. A failing test leg blocks the merge — fix forward rather than disabling the check.

Keep the branch focused: if the diff grows beyond ~300 lines of non-generated code, split it.

Commit messages

We follow Conventional Commits:

<type>(<scope>): <description>

[optional body]

[optional footer]

Types: feat, fix, docs, refactor, test, chore, ci.

Examples:

feat(routing): add PROVIDER_IGNORE valve
fix(stream): close think tag on mid-stream error
docs: update README installation steps
test: add retry exhaustion coverage

Coding standards

  • PEP 8 — enforced by convention; keep line length ≤ 100 chars.
  • Type hints on every function signature.
  • One responsibility per method — keep functions under ~50 lines; extract helpers when they grow.
  • Docstrings on every public method using the one-line summary style.
  • Logging via print(f"[OpenRouter Pipe] …") — never log API keys or user content.
  • No any-equivalent type erasure; use proper dict[str, Any] annotations.

Testing

  • Framework: Python unittest (stdlib).
  • Mock strategy: unittest.mock.patch for HTTP calls and Open WebUI internals.
  • Conventions:
    • Test path mirrors source: openrouter_pipe.py ↔ test_pipe.py.
    • Each test class covers one unit (TestPreparePayload, TestStreamResponse, etc.).
    • Use descriptive method names: test_fallback_deduplication_removes_duplicates.
  • Run the suite the same way CI does: python test_pipe.py. Integration tests require a live API key and are optional for most contributions.

Reporting bugs

When reporting a bug, open a GitHub issue using the Bug report template and include:

  1. Open WebUI version (Admin Panel → About).
  2. Python version (python --version).
  3. Steps to reproduce the issue.
  4. Expected vs. actual behavior.
  5. Error logs — check the Open WebUI server logs and filter for [OpenRouter Pipe] messages.

Do not include your API key in the issue. Redact it before pasting logs.

Suggesting features

Before opening a feature request:

  1. Check the OpenRouter API docs to confirm the feature exists upstream.
  2. Check the Open WebUI Pipe docs for compatibility constraints.
  3. Open an issue using the Feature request template and describe the use case and expected behavior.

Thanks for helping improve OpenRouter Pipe! 🚀