Contributing

Thank you for your interest in contributing! We welcome all contributions no matter their size. Please read along to learn how to get started. If you get stuck, feel free to ask for help in Ethereum Python Discord server.

Setting the stage

To get started, fork the repository to your own github account, then clone it to your development machine:

git clone git@github.com:your-github-username/hexbytes.git
cd hexbytes

Next, install the development dependencies with uv. The dev dependency group is installed by default, so uv sync is enough for a local development environment.

uv sync
uv run prek install

Running the tests

A great way to explore the code base is to run the tests.

We can run all tests with:

uv run pytest

Code Style

We use prek to enforce a consistent code style across the library. This tool runs automatically with every commit, but you can also run our linting tools manually with:

ruff check
ruff format
mypy .

If you need to make a commit that skips the prek checks, you can do so with git commit --no-verify.

This library uses type hints, which are enforced by the mypy tool (part of the prek checks). All new code is required to land with type hints, with the exception of code within the tests directory.

Documentation

Good documentation will lead to quicker adoption and happier users. Please check out our guide on how to create documentation for the Python Ethereum ecosystem.

Pull Requests

It’s a good idea to make pull requests early on. A pull request represents the start of a discussion, and doesn’t necessarily need to be the final, finished submission.

GitHub’s documentation for working on pull requests is available here.

Once you’ve made a pull request, take a look at the GitHub Actions build status in the GitHub interface and make sure all tests are passing. In general pull requests that do not pass the CI build yet won’t get reviewed unless explicitly requested.

If the pull request introduces changes that should be reflected in the release notes, include the user-facing summary in the pull request description. Release notes are published through GitHub Releases.

Releasing

Releases are published from GitHub Releases. The release tag is the source of truth for the package version, and setuptools-scm derives the version during the publishing workflow.

Final review before each release

Before releasing a new version, build and test the package that will be released:

git checkout main && git pull
uv build
uv run pytest
uv run ruff check
uv run ruff format --check
uv run mypy .

Review the documentation that will get published:

uv run --group docs sphinx-build -b html -W docs docs/_build/html
uv run --group docs sphinx-build -b doctest -W docs docs/_build/doctest

Push the release to github & pypi

After confirming that the release package looks okay:

Draft a new GitHub Release.
Choose the release tag, for example v2.0.0.
Add the release notes.
Publish the release.

Publishing the GitHub Release triggers the trusted publishing workflow. The workflow builds the package with uv build and publishes it to PyPI through PyPI OIDC.