Skip to content

Add pre-commit instructions to readme #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wenruifan merged 1 commit into from
Sep 15, 2025
Merged

Add pre-commit instructions to readme #8

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@

This repository provides the base source code for the MultimodalAI'25 workshop Hackathon. It is designed to help participants get started quickly with a pre-configured Python environment and essential dependencies for development and testing.

Further details about the hackathon are available on the [Wiki webpage](https://github.com/pykale/mmai-hackathon/wiki).

## Requirements

- Python 3.10, 3.11, or 3.12
Expand Down Expand Up @@ -83,12 +85,14 @@ echo "Using PyG wheel index: $PYG_INDEX"

More details: https://pytorch-geometric.readthedocs.io/en/latest/notes/installation.html

### 3) (Optional) Pre‑commit hooks
### 3) Pre‑commit hooks

```bash
pre-commit install
```

Then open terminal and navigate to the repository folder, and you can use `pre-commit run --all` to check all files.

### 4) Run tests

```bash
Expand Down