Skip to content

Commit 6e34d1b

Browse files
Update contribution guide (#460)
Signed-off-by: Emmanuel Ferdman <emmanuelferdman@gmail.com>
1 parent f00a806 commit 6e34d1b

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ If you now include the changed files in your commit, it should succeed.
4646

4747
### Where
4848

49-
* Select a folder under [notebooks](../notebooks/README.md) that matches the category of your notebook. If none of them match, create a new folder.
49+
* Select a folder under [notebooks](notebooks/README.md) that matches the category of your notebook. If none of them match, create a new folder.
5050

5151
### What
5252

@@ -64,7 +64,7 @@ If you now include the changed files in your commit, it should succeed.
6464
* We recommend building the notebook in an interactive environment, such as [Google Colab](https://colab.google/). This way you can test all the steps and capture the output.
6565
* **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 notebook.
6666
* Test your notebook end to end before submitting a pull request.
67-
* Example of a well-formed notebook: [question-answering.ipynb](../notebooks/generative-ai/question-answering.ipynb).
67+
* Example of a well-formed notebook: [question-answering.ipynb](notebooks/generative-ai/question-answering.ipynb).
6868

6969
### Automated testing
7070

@@ -105,7 +105,7 @@ Any notebooks that are added in subdirectories under `notebooks` are automatical
105105

106106
### Where
107107

108-
* Select a folder under [example-apps](../example-apps/README.md) that matches the category of your applications. If none of them match, create a new folder.
108+
* Select a folder under [example-apps](example-apps/README.md) that matches the category of your applications. If none of them match, create a new folder.
109109
* Create a folder under the category for your applications.
110110

111111
### What
@@ -116,15 +116,15 @@ Any notebooks that are added in subdirectories under `notebooks` are automatical
116116
* Add a `README.md` file in the root folder of the app:
117117
* Summarize what the app will demonstrate. Feel free to use images - sometimes a picture is worth a thousand words.
118118
* List language requirements in the readme file, e.g. "Python 3.6+".
119-
* List clear instructions for installing and runing the example app in the readme file. This includes
119+
* List clear instructions for installing and running the example app in the readme file. This includes
120120
* Upload sample data files as necessary, or instructions for downloading them from an external source. Consider the license for any datasets.
121121
* Mention the version of the Elastic Stack that the example was tested with.
122122

123123
### How
124124

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.
127-
* Example of a well-formed app: [OpenAI-JS](../example-apps/OpenAI-embeddings/OpenAI-JS/README.md).
127+
* Example of a well-formed app: [OpenAI-JS](example-apps/openai-embeddings/README.md).
128128

129129
## Examples for the Elastic Search Labs Blog
130130

0 commit comments

Comments
 (0)