From 8f60ad0a239b790c282a785f56176d0e2865f193 Mon Sep 17 00:00:00 2001 From: Tamo Date: Wed, 10 Jul 2024 14:38:19 +0200 Subject: [PATCH] apply review comments --- CONTRIBUTING.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 429de8a82..da84787d8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -56,6 +56,13 @@ This command will be triggered to each PR as a requirement for merging it. You can set the `LINDERA_CACHE` environment variable to speed up your successive builds by up to 2 minutes. It'll store some built artifacts in the directory of your choice. +⚠ The directory must exist; otherwise, an error will be thrown while building Meilisearch. + +We recommend using the standard `$HOME/.cache/lindera` directory: +```sh +mkdir $HOME/.cache/lindera +export LINDERA_CACHE=$HOME/.cache/lindera +``` #### Snapshot-based tests @@ -68,7 +75,7 @@ Furthermore, we provide some macros on top of insta, notably a way to use snapsh To effectively debug snapshot-based hashes, we recommend you export the `MEILI_TEST_FULL_SNAPS` environment variable so that snapshot are fully created locally: -``` +```sh export MEILI_TEST_FULL_SNAPS=true # add this to your .bashrc, .zshrc, ... ```