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
-[ ] I have coordinated with the docs team ([email protected]) if this PR deletes files or changes any file names or file extensions.
9
12
-[ ] Pull request includes test coverage for the included changes.
10
13
-[ ] This notebook or file is added to the [CODEOWNERS](https://github.com/Azure/azureml-examples/blob/main/.github/CODEOWNERS) file, pointing to the author or the author's team.
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+10-7Lines changed: 10 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -29,13 +29,13 @@ This repository contains notebooks and sample code that demonstrate how to devel
29
29
30
30
## Issues
31
31
32
-
All forms of feedback are welcome through [issues](https://github.com/Azure/azureml-examples/issues/new/choose) - please follow the pre-defined templates where applicable.
32
+
All forms of feedback are welcome through [issues](https://github.com/Azure/azureml-examples/issues/new/choose). Please follow the pre-defined templates where applicable.
33
33
34
34
## Repository structure
35
35
36
36
Azure Machine Learning has multiple developer experiences. The subdirectories at the root of the repo correspond to a developer experience, with the slight exception of `notebooks`.
37
37
38
-
The `notebooks` directory is intended for iterative, interactive code development examples such as exploratory data anlysis or querying logged metrics.
38
+
The `notebooks` directory is intended for iterative, interactive code development examples such as exploratory data analysis or querying logged metrics.
39
39
40
40
## Pull Requests
41
41
@@ -67,30 +67,33 @@ Also if adding new examples or changing existing descriptions, run the `readme.p
67
67
python readme.py
68
68
```
69
69
70
-
This will also generate a GitHub Actions workflow file for any new examples in the `.github/workflows` directory (with exceptions) to test the examples on the PR and regularly after merging into the main branch. PRs which edit existing examples will generally trigger a workflow to test the example. See the specific contributing guidelines for the subdirectories for further details. If the new notebook uses compute cluster, please add it to the `sdk/python/notebooks_config.ini` file so the compute clusters will be properly deleted after notebook run was finished. Create a section with the notebook name and add the option `COMPUTE_NAMES` with the compute cluster name.
70
+
This will also generate a GitHub Actions workflow file for any new examples in the `.github/workflows` directory (with exceptions) to test the examples on the PR and regularly after merging into the main branch. PRs which edit existing examples will generally trigger a workflow to test the example. See the specific contributing guidelines for the subdirectories for further details. If the new notebook uses a compute cluster, please add it to the `sdk/python/notebooks_config.ini` file so the compute clusters will be properly deleted after notebook run was finished. Create a section with the notebook name and add the option `COMPUTE_NAMES` with the compute cluster name.
71
71
72
72
### Discoverability
73
73
74
74
Examples in this repository can be indexed in the [Microsoft code samples browser](https://docs.microsoft.com/samples), enabling organic discoverability. To accomplish this:
75
75
76
-
- add an excellent `README.md` file in the example directory
76
+
- add an excellent `README.md` file in the example directory noting the overview, objective, and estimated runtime. (Note than estimated runtimes should not exceed 30 minutes).
77
77
- add required YAML frontmatter at the top of the `README.md`
78
78
79
-
The YAML frontmatter is this:
79
+
The YAML frontmatter format looks like this:
80
80
81
81
```YAML
82
82
---
83
83
page_type: sample
84
84
languages:
85
85
- azurecli
86
-
- python
86
+
- language1
87
+
- language2
87
88
products:
88
89
- azure-machine-learning
89
90
description: Example description.
90
91
---
91
92
```
92
93
93
-
**Edit the description** and update the languages as needed.
94
+
Edit the description and update the languages as needed.
95
+
96
+
The Code Samples browser content is updated twice a week, so it may take a few days for your changes to be reflected.
All SDK samples should be provided as Jupyter notebooks. Please follow the [pre-defined notebook template](../infra/templates/notebook_template.ipynb) and the instructions on [the main CONTRIBUTING page](../CONTRIBUTING.md).
6
+
7
+
**Important:** PRs from forks of this repository are likely to fail automated workflows due to access to secrets. PRs from forks will be considered but may experience additional delay for testing.
0 commit comments