Thanks for your interest in contributing!
-
Clone the repository:
git clone https://github.com/your-username/dev-tools-hooks.git cd dev-tools-hooks -
Create a virtual environment:
python3 -m venv venv source venv/bin/activate -
Install in development mode:
pip install -e .
- Follow PEP 8 guidelines
- Use type hints where possible
- Keep functions focused and small
- Create a new branch:
git checkout -b feat/your-feature - Make your changes
- Test locally:
dev-hooks install && dev-hooks list - Commit using conventional commits:
feat: add new feature - Push and create a Pull Request
- Create your hook script in
hooks/ - Copy it to
src/dev_tools_hooks/hooks/ - Add the hook name to
AVAILABLE_HOOKSininstaller.py - Update the
cmd_listfunction incli.pywith a description