Skip to content
Merged
Changes from 6 commits
Commits
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
36 changes: 36 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,42 @@ ______________________________________________________________________

## Guidelines

### Development environment

To set up a local development environment, begin by cloning the repository:

```bash
git clone https://github.com/Lightning-AI/lightning.git
cd lightning
```

Once in root level of the repository, install the dependencies using a package manager of your choice:

```bash
# pip
python -m venv .venv
source .venv/bin/activate
pip install ".[dev, examples]"

# uv
uv venv
source .venv/bin/activate
uv pip install ".[dev, examples]"
```

Once the dependencies have been installed, install pre-commit and set up the git hook scripts:

```bash
# pip
pip install pre-commit

# uv
uv pip install pre-commit

# Install git hook scripts
pre-commit install
```

### Developments scripts

To build the documentation locally, simply execute the following commands from project root (only for Unix):
Expand Down