Skip to content

Commit d5dff87

Browse files
Updating CONTRIBUTING.md (#423)
1 parent ffb6011 commit d5dff87

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

CONTRIBUTING.md

+16
Original file line numberDiff line numberDiff line change
@@ -125,3 +125,19 @@ Any notebooks that are added in subdirectories under `notebooks` are automatical
125125
* **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.
126126
* Test your app end to end before submitting a pull request.
127127
* Example of a well-formed app: [OpenAI-JS](../example-apps/OpenAI-embeddings/OpenAI-JS/README.md).
128+
129+
## Examples for the Elastic Search Labs Blog
130+
131+
If you are contributing an example corresponding to a blog post, use the folder `supporting-blog-content`.
132+
133+
### Troubleshooting
134+
135+
- If the pre-commit checks are failing. You may want to try running the checks this way:
136+
137+
```
138+
python -m venv .venv
139+
.venv/bin/pip install -qqq -r requirements-dev.txt
140+
.venv/bin/pre-commit install
141+
```
142+
143+
- If you are still having issues, you may want to double-check that your code is in the folder `supporting-blog-content`.

0 commit comments

Comments
 (0)