mirror of https://github.com/ivuorinen/aeonview.git synced 2026-03-13 14:58:33 +00:00

Files

Copilot 265f8de06b feat: migrate to uv-managed project (#10 )

* Initial plan

* feat: migrate to uv-managed project

Co-authored-by: ivuorinen <11024+ivuorinen@users.noreply.github.com>

* fix: align Python version in pyproject.toml and CI setup-uv config

Co-authored-by: ivuorinen <11024+ivuorinen@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: ivuorinen <11024+ivuorinen@users.noreply.github.com>

2026-03-13 08:42:08 +02:00

1.7 KiB

Raw Blame History

Contributing to aeonview

Thanks for your interest in contributing to aeonview! This guide will help you get started.

🛠 Project Setup

Clone the repository:

git clone https://github.com/ivuorinen/aeonview.git
cd aeonview

Set up your environment:
```
uv sync --all-groups
```
Install pre-commit hooks:
```
uv run pre-commit install
```

✅ Development Workflow

Make sure your changes are well-tested.
Use make check to run linting and tests.
Follow the existing coding style (Ruff will enforce it).
All new features must include documentation.

🧪 Running Tests

make test

🧹 Formatting & Linting

make format   # auto-format code
make lint     # check for lint errors

✅ Submitting a Pull Request

Create a feature branch:
```
git checkout -b feature/my-new-feature
```

Commit your changes:

git add .
git commit -m "feat: add support for X"

Push and open a pull request:
```
git push origin feature/my-new-feature
```
Follow the PR template and link any relevant issues.

📋 Commit Message Guidelines

Use Conventional Commits:

Examples:

feat: add monthly video generation
fix: handle invalid date error
docs: update usage instructions

🙏 Code of Conduct

We expect contributors to follow our Code of Conduct.

Questions?

Feel free to open an issue or start a discussion!

Thanks for helping make Aeonview better 💜

1.7 KiB Raw Blame History