Contributing Guide

Welcome! Thank you for your interest in improving python-boilerplate/uv-template. This project is my personal template, and only bug fixes are accepted.

🐞 Reporting a Bug

Before submitting a bug report:

Check that the issue hasn’t already been reported in the Issues section.

When reporting a bug, please include:

Steps to reproduce the bug
Expected vs actual behavior
Any logs, error traces, or screenshots (if applicable)
Details about your Python version, OS, and any relevant environment info

Clear, detailed bug reports or feature descriptions help address problems faster.

🔄 How to Contribute (Pull Request)

Fork this repository to your own GitHub account.
Create a branch for your fix.
Branch naming suggestion: fix/short-bug-description
Apply your changes on that branch (if it's a bug).
Test your code:
- Run the test suite:
```
make test
```
- Run the linter:
```
make lint && make format
```
Describe your PR clearly and informatively.
Open a Pull Request from your branch to this repository.

✅ Code Requirements

!

Follow the existing code style.
Make sure all tests pass (pytest) (if needed).
Lint and Format your code with ruff before submitting (if needed).
Do not add new features or change existing functionality without agreement.

❓ Questions

!

If you have questions about contributing,
please open an issue or comment on an existing one.

Thank you for helping make this template better!