You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -46,7 +46,7 @@ If you now include the changed files in your commit, it should succeed.
46
46
47
47
### Where
48
48
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.
50
50
51
51
### What
52
52
@@ -64,7 +64,7 @@ If you now include the changed files in your commit, it should succeed.
64
64
* 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.
65
65
***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.
66
66
* 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).
68
68
69
69
### Automated testing
70
70
@@ -105,7 +105,7 @@ Any notebooks that are added in subdirectories under `notebooks` are automatical
105
105
106
106
### Where
107
107
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.
109
109
* Create a folder under the category for your applications.
110
110
111
111
### What
@@ -116,15 +116,15 @@ Any notebooks that are added in subdirectories under `notebooks` are automatical
116
116
* Add a `README.md` file in the root folder of the app:
117
117
* Summarize what the app will demonstrate. Feel free to use images - sometimes a picture is worth a thousand words.
118
118
* 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
120
120
* Upload sample data files as necessary, or instructions for downloading them from an external source. Consider the license for any datasets.
121
121
* Mention the version of the Elastic Stack that the example was tested with.
122
122
123
123
### How
124
124
125
125
***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.
126
126
* 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).
0 commit comments