Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
92 lines (57 loc) · 2.67 KB

CONTRIBUTING.md

File metadata and controls

92 lines (57 loc) · 2.67 KB
Raw

Contributing

The Python SDK is currently in beta.

During beta, we are using GitHub Issues as the primary public feedback channel. Please open an issue for bug reports, feature requests, or general feedback.

We are not broadly accepting external pull requests yet. Large changes should not be started without prior discussion and agreement with the Polymarket team.

Once the SDK is stable and out of beta, we will expand these guidelines and start opening the project to external contributions.

Development Setup

make sync

Checks

make check

Dependency Policy

Runtime dependencies should use conservative ranges in pyproject.toml.

Development and CI dependencies are locked in uv.lock.

Do not pin transitive dependencies in published package metadata unless there is a known incompatibility.

Tests

Unit tests should be deterministic and avoid live network calls.

Integration tests must be marked with @pytest.mark.integration and must be safe to skip in default CI.

Integration tests that need credentials should read them through the require_env fixture instead of calling os.environ directly at import time. Missing credentials should skip the test, not fail collection.

import pytest


@pytest.mark.integration
def test_authenticated_flow(require_env):
    private_key = require_env("POLYMARKET_PRIVATE_KEY")

For local runs, copy .env.example to .env and fill only the values needed by the tests you are running:

cp .env.example .env
make test-integration

Use disposable test credentials only. Never commit .env files or real secrets. In GitHub Actions, define the names from .env.example as repository or environment secrets instead of generating .env files.

Tests that place orders, spend funds, or mutate live state must also use @pytest.mark.metered. Metered tests are skipped unless POLYMARKET_RUN_METERED_TESTS=1 is set.

import pytest


@pytest.mark.integration
@pytest.mark.metered
def test_order_lifecycle(require_env):
    private_key = require_env("POLYMARKET_PRIVATE_KEY")
POLYMARKET_RUN_METERED_TESTS=1 make test-integration

Releases

Use Conventional Commits. Release PRs and changelog updates are managed by release-please.

Commit subjects and PR titles must use this format:

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

Examples:

feat: add market lookup
fix(auth): refresh expired credentials

Allowed types are build, chore, ci, docs, feat, fix, perf, refactor, revert, style, and test.

If using squash merges, make sure the squash commit title matches the PR title so release-please can classify the change after it lands on main.