Skip to content

Contributing to kraken-connector

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs at https://github.com/tlg7c5/kraken-connector/issues

If you are reporting a bug, please include:

  • Your operating system name and version.
  • Python version and kraken-connector version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with "bug" and "help wanted" is open to whoever wants to implement a fix for it.

Implement Features

Look through the GitHub issues for features. Anything tagged with "enhancement" and "help wanted" is open to whoever wants to implement it.

Write Documentation

kraken-connector could always use more documentation, whether as part of the official docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/tlg7c5/kraken-connector/issues.

If you are proposing a new feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.
  • Remember that this is a volunteer-driven project, and that contributions are welcome.

Prerequisites

  • Python 3.11 or later
  • PDM for dependency management
  • Git

Get Started

Ready to contribute? Here's how to set up kraken-connector for local development.

  1. Fork the kraken-connector repo on GitHub.

  2. Clone your fork locally:

git clone git@github.com:YOUR_NAME/kraken-connector.git
cd kraken-connector
  1. Install the environment and pre-commit hooks:
make install

This runs pdm install and pdm run pre-commit install. If you are using pyenv, select a version first:

pyenv local 3.11
  1. Create a branch for local development:
git checkout -b name-of-your-bugfix-or-feature

Now you can make your changes locally.

  1. Add test cases for your changes to the tests directory.

  2. Run code quality checks (linting, type checking, dependency audit):

make check
  1. Run the test suite:
make test
  1. (Optional) Run tox to test across Python versions. This also runs in CI, so you can skip it locally:
tox
  1. Commit your changes and push your branch to GitHub:
git add .
git commit -m "Your detailed description of your changes."
git push origin name-of-your-bugfix-or-feature
  1. Submit a pull request through the GitHub website.

Serving docs locally

To preview documentation changes:

make docs

This runs mkdocs serve and opens a local preview at http://127.0.0.1:8000. Changes to doc files are hot-reloaded.

To validate that docs build without errors:

make docs-test

Code style

  • Formatting: Black (line length 88)
  • Linting: Ruff with a broad rule set (see pyproject.toml for details)
  • Type checking: mypy with strict settings (disallow_untyped_defs, disallow_any_unimported)
  • Docstrings: Google format

Pre-commit hooks enforce formatting and linting automatically on each commit.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

  1. The pull request should include tests.
  2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a Google-format docstring.
  3. All CI checks (lint, type check, tests) should pass.