Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
25 lines (17 loc) · 997 Bytes

CONTRIBUTING.md

File metadata and controls

25 lines (17 loc) · 997 Bytes

Contribution Guide

All contributions to the rs-clob-client are welcome and greatly appreciated! This document serves to outline the process for contributions and help you get set up.

Steps to get started

  1. Fork Polymarket/rs-clob-client
  2. Clone your fork
  3. Install pre-commit
  4. Open pull requests with the wip label against the main branch and include a description of the intended change in the PR description.

Before removing the wip label and submitting a PR for review, make sure that:

  • It passes all checks, including lints and tests
  • Your fork is up to date with main

Branch structure & naming

Our main branch, main, represents the current development state of the codebase. All pull requests should be opened against main.

Please follow the conventional commits standard when naming your PR.