Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
39 lines (27 loc) · 1.1 KB

CONTRIBUTING.md

File metadata and controls

39 lines (27 loc) · 1.1 KB
Raw

Contributing

Thank you for your interest in capsolver-core.

This repository is maintained by the CapSolver team. Issues and pull requests are welcome when they are focused on bugs, documentation, compatibility, or small improvements to the public SDK surface.

Before You Start

  • Search existing issues before opening a new one.
  • Open an issue before starting a large change.
  • Do not include real API keys, cookies, private URLs, or customer data in issues, tests, examples, or screenshots.
  • Keep examples token-mode focused and use placeholder credentials.

Development

uv sync --all-extras
uv run pytest
uv run ruff check src tests
uv run mypy src

If you do not use uv, install the development dependencies from requirements-dev.txt and run the equivalent commands with Python.

Pull Requests

Pull requests should include:

  • A clear description of the change.
  • Tests or a short explanation of why tests are not needed.
  • Documentation updates for user-facing behavior.

Maintainers may close changes that are outside the public SDK scope or require private service-side details.