Contributing to syncweaver

Proposing changes with issues

If you want to make a change, it’s a good idea to first open an issue and make sure someone from the team agrees that it’s needed.

If you’ve decided to work on an issue, assign yourself to the issue so others will know you’re working on it.

Pull request process

We use GitHub Flow as our collaboration process.

Commit messages

Commit messages must follow Conventional Commits. The conventional-pre-commit hook enforces this on commit.

Setup

git clone https://github.com/CCBR/syncweaver
cd syncweaver
pip install -e ".[dev,test,docs]"
pre-commit install

Running tests

pytest

Code style

Python code is formatted with ruff. Run ruff format src/ tests/ before committing, or let the pre-commit hook handle it.