Skip to content

Commit

Permalink
Move the pre-commit installation a bit earlier in the docs
Browse files Browse the repository at this point in the history
This makes the pre-commit installation happen before Julia is opened, so
users don't have to open a second terminal, or close and reopen Julia.

Closes #303
  • Loading branch information
abelsiqueira committed Jul 8, 2024
1 parent 60300ac commit 03cf361
Showing 1 changed file with 9 additions and 8 deletions.
17 changes: 9 additions & 8 deletions docs/src/10-full-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,15 @@ If you decide to gradually adopt, do this:
Install a plugin on your editor to use [EditorConfig](https://editorconfig.org).
This will ensure that your editor is configured with important formatting settings.

We use [https://pre-commit.com](https://pre-commit.com) to run the linters and formatters.
We recommend using [https://pre-commit.com](https://pre-commit.com) to run linters and formatters.
If you select the "recommended" options later on, you will need `pre-commit` installed.
To install `pre-commit`, we recommend using [pipx](https://pipx.pypa.io) as follows:

```bash
# Install pipx following the link
pipx install pre-commit
```

In particular, the Julia code is formatted using [JuliaFormatter.jl](https://github.com/domluna/JuliaFormatter.jl), so please install it globally first:

```julia-repl
Expand All @@ -43,13 +51,6 @@ pkg> activate
pkg> add JuliaFormatter
```

To install `pre-commit`, we recommend using [pipx](https://pipx.pypa.io) as follows:

```bash
# Install pipx following the link
pipx install pre-commit
```

## Install BestieTemplate (or copier)

To use the template, we recommend installing the package `BestieTemplate.jl` globally:
Expand Down

0 comments on commit 03cf361

Please sign in to comment.