Skip to content

Added documentation for code formatting tools (ref #370) #371

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
merged 2 commits into from
May 13, 2025
Merged

Added documentation for code formatting tools (ref #370) #371

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
63b65cb
Added documentation for code formatting tools (ref #370)
May 10, 2025
c3afabe
Formatting fix
May 10, 2025
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
30 changes: 30 additions & 0 deletions src/contributors/02-local-development.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,36 @@ psql -c 'create database lemmy with owner lemmy;' -U postgres
export LEMMY_DATABASE_URL=postgres://lemmy:password@localhost:5432/lemmy
```

### Code formatting tools

#### Taplo

See installation instructions [here](https://taplo.tamasfe.dev/), or run

```bash
cargo install taplo-cli --locked
```

#### pg_format

Debian-based distro:

```bash
sudo apt install pgformatter
```

Arch-based distro:

```bash
sudo pacman -S pgformatter
```

macOS:

```bash
brew install pgformatter
```

### Get the code

Clone frontend and backend code to local folders. Be sure to include `--recursive` to initialize git submodules.
Expand Down