Contributing

Contributing

Printbuddy welcomes focused contributions, especially reproducible bug reports and small, testable fixes.

Before contributing

• Check existing issues.
• Make sure your change targets the correct repository: vmhomelab/Printbuddy.
• Use the dev branch for pull requests.
• Keep provider-specific behavior separated.

Development setup

Backend:

python3 -m venv venv
./venv/bin/pip install -r requirements.txt -r requirements-dev.txt
ruff check backend/
ruff format --check backend/
cd backend
../venv/bin/python -m pytest tests/ --tb=short

Frontend:

cd frontend
npm ci
npm run lint
npx tsc --noEmit
npm run test:run
npm run build

Pull request expectations

• Explain what changed and why.
• Include tests for behavior changes.
• Do not mix unrelated cleanup with feature work.
• Redact secrets from logs and screenshots.