Skip to content
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

Add missing build steps to CONTRIBUTING.md #4045

Merged
merged 1 commit into from
Mar 11, 2025
Merged

Add missing build steps to CONTRIBUTING.md #4045

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
12 changes: 9 additions & 3 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,12 @@ Use the `gem` package manager to install the [Ruby bundler](https://bundler.io/)
$ gem install bundler
```

And then install the required Ruby gems:

```console
$ bundle install
```

Configure a Python virtual environment for this project:

```console
Expand All @@ -101,12 +107,12 @@ $ source .env/bin/activate
```

> [!TIP]
> When you're using a virtual environment, you should see a `(.venv)` prefix at the start of your terminal prompt. At any time, run the `deactivate` command to exit the virtual environment.
> When you're using a virtual environment, you should see a `(.env)` prefix at the start of your terminal prompt. At any time, run the `deactivate` command to exit the virtual environment.

In the virtual environment, install the [YAML module for Python 3](https://formulae.brew.sh/formula/pyyaml#default):
In the virtual environment, install the required Python modules:

```console
$ pip3 install pyyaml
$ pip3 install -r requirements.txt
```

### Build HTML
Expand Down
Loading