54 lines (37 loc) · 1.35 KB

Contributing to pyu

Thank you for considering contributing to the pyu project!

Branch Naming Strategy

Feature branches: f-<number> (e.g., f-101)
Bugfix branches: b-<number> (e.g., b-202)

Please use the appropriate prefix and a unique number for your branch name.

Pre-commit Hooks

We use pre-commit to maintain code quality. All contributors must install and configure pre-commit hooks before making commits.

Installation

Install pre-commit (requires Python):
```
pip install pre-commit
```
Install the hooks:
```
pre-commit install
```
(Optional) Run hooks on all files:
```
pre-commit run --all-files
```

Configuration

The configuration file is .pre-commit-config.yaml in the project root. Hooks will run automatically on git commit.

Contribution Steps

Fork the repository and clone your fork.
Create a new branch using the naming strategy above.
Install and configure pre-commit hooks.
Make your changes and commit (hooks will run automatically).
Push your branch and open a pull request.

Code Style & Guidelines

Follow existing code style and conventions.
Write clear commit messages.
Add tests for new features or bug fixes.

Need Help?

Open an issue or contact the maintainers for assistance.

Happy contributing!