Development

Development Guide

So, you wanna contribute? Cool! First, make sure you have uv and git installed.

Environment Setup

git clone https://github.com/wojtmic/prefixer
cd prefixer
uv sync # this will fully set up the virtual environment

If you plan to develop tweaks, make sure to symlink your project prefixer/data/tweaks folder to ~/.config/prefixer/tweaks

ln -s /absolute/path/to/dev/prefixer/data/tweaks /home/myuser/prefixer/tweaks

Guidelines

• The general guidelines are present in the main repo, here.
• For developing tweaks specifically, here

Opening a PR

Make sure your PR title starts with either:

• feat: for user-facing features
• fix: for bug fixes
• chore: for development process (CI/CD, etc.)
• style: for non-functional style changes
• refactor: for rewriting code without functional benefits
• perf: for performance improvements
• test: for unit tests
• docs: for markdown updates (documentation)
• tweak: for tweaks without code
  If your PR's title doesn't start with one of these, it will be automatically rejected