Contributing to KrakenHashes¶

Thank you for your interest in contributing to KrakenHashes! This section contains guides for different ways you can help improve the project.

Ways to Contribute¶

Translations

Help make KrakenHashes accessible to users worldwide by contributing translations to your language.
Bug Reports

Found a bug? Open an issue on GitHub with details to reproduce it.
Feature Requests

Have an idea? Start a discussion or open an issue to propose new features.
Code Contributions

Submit pull requests for bug fixes, features, or documentation improvements.

Getting Started¶

Fork the repository on GitHub
Clone your fork locally
Create a branch for your contribution
Make your changes following the relevant guide
Submit a pull request with a clear description

Editing the documentation¶

Build the site locally before pushing, so a broken link is caught by you rather than by CI:

scripts/docs-build.sh          # strict build -- the pre-push check
scripts/docs-build.sh serve    # live-reloading preview on http://127.0.0.1:8000
scripts/docs-build.sh clean    # remove the virtualenv and the built site

The first run creates a Python virtualenv and installs requirements-docs.txt into it, which takes a minute; after that a build is about ten seconds. Dependencies are only reinstalled when requirements-docs.txt changes.

Why a script rather than plain pip install

Arch, Debian 12+, Fedora and Ubuntu 23.10+ ship PEP 668 "externally managed" Pythons, which refuse pip install outside a virtualenv. CI installs onto a clean runner and does not hit this; the script owns a virtualenv so your machine matches CI without you managing one. It lives outside the repository, so it is never committed and survives git clean.

--strict fails the build on mkdocs warnings, which includes a link to a file that does not exist. Unresolved anchors are reported at INFO and do not fail the build, so read the output as well as the exit code when adding cross-references.

New pages are picked up automatically. Adding one to mkdocs.yml's nav puts it in the sidebar; leaving it out means it is reachable only from links on other pages, which is the existing convention for provider- and mode-specific sub-pages.

Community¶

Join our Discord server to connect with other contributors and get help with your contributions.

Code of Conduct¶

Please be respectful and constructive in all interactions. We're building this together!