# 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 `kuestcom/rs-clob-client`
1. Clone your fork
1. Install [pre-commit](https://pre-commit.com/#intro)
1. Open pull requests with the [wip](https://github.com/kuestcom/rs-clob-client/issues/labels?q=label%3Awip) 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](https://www.conventionalcommits.org/en/v1.0.0/) standard when
naming your PR.
