From d5dff87b747002854d940eb889b454c3b144be55 Mon Sep 17 00:00:00 2001 From: Jessica Garson Date: Sun, 16 Mar 2025 08:54:01 -0400 Subject: [PATCH] Updating CONTRIBUTING.md (#423) --- CONTRIBUTING.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8b01bcc48..3945f730e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -125,3 +125,19 @@ Any notebooks that are added in subdirectories under `notebooks` are automatical * **Never leave any secrets in the code** (API keys, passwords etc). Also avoid hardcoding URLs and IDs that may change from user to user. Instead use environment variables that need to be set by the user while they are running the app. * Test your app end to end before submitting a pull request. * Example of a well-formed app: [OpenAI-JS](../example-apps/OpenAI-embeddings/OpenAI-JS/README.md). + +## Examples for the Elastic Search Labs Blog + +If you are contributing an example corresponding to a blog post, use the folder `supporting-blog-content`. + +### Troubleshooting + +- If the pre-commit checks are failing. You may want to try running the checks this way: + + ``` + python -m venv .venv + .venv/bin/pip install -qqq -r requirements-dev.txt + .venv/bin/pre-commit install + ``` + +- If you are still having issues, you may want to double-check that your code is in the folder `supporting-blog-content`. \ No newline at end of file