From 093e749475ca245cab5861752352019b2fc7b021 Mon Sep 17 00:00:00 2001 From: Sarah Segel <30651149+sarah-segel@users.noreply.github.com> Date: Thu, 4 May 2023 11:16:33 +0200 Subject: [PATCH] Adapt developer install instructions to include pre-commit installation (#994) --- CHANGELOG.md | 1 + README.md | 4 ++-- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index a8c2df94f..d21dc5647 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,7 @@ ## Improvements - Callbacks registration is now a public method of the optimizer and allows callbacks to be inserted at a specific position. +- Adapt developer install instructions to include pre-commit installation ## Bugfixes - Adjust amount of configurations in different stages of hyperband brackets to conform to the original paper. diff --git a/README.md b/README.md index 03999059a..e546e8356 100644 --- a/README.md +++ b/README.md @@ -57,10 +57,10 @@ Install SMAC via PyPI: pip install smac ``` -Or alternatively, clone the environment: +If you want to contribute to SMAC, use the following steps instead: ``` git clone https://github.com/automl/SMAC3.git && cd SMAC3 -pip install -e .[dev] +make install-dev ```