Skip to content

Commit cfed266

Browse files
authored
Update CONTRIBUTING.md and add sdk/CONTRIBUTING.md (#2693)
* Update CONTRIBUTING.md * Add CODEOWNERS check to pull request template * Update CONTRIBUTING.md Goals section * Update CONTRIBUTING.md Goals section * Fix typos * Update CONTRIBUTING.md Non-goals section * Update wording for Non-goals * Update CONTRIBUTING.md additional resources * Update main contributing guide * Add SDK contributing guide * Update pull request template * Update pull request template * Remove pull request merge/approval section * Add notice about code samples update timing * Add link to template
1 parent e9b56f9 commit cfed266

File tree

3 files changed

+21
-8
lines changed

3 files changed

+21
-8
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,10 @@
44
# Checklist
55

66

7-
- [ ] I have read the [contribution guidelines](https://github.com/Azure/azureml-examples/blob/main/CONTRIBUTING.md)
7+
- [ ] I have read the contribution guidelines.
8+
- [General](https://github.com/Azure/azureml-examples/blob/main/CONTRIBUTING.md)
9+
- [SDK](https://github.com/Azure/azureml-examples/blob/main/sdk/CONTRIBUTING.md)
10+
- [CLI](https://github.com/Azure/azureml-examples/blob/main/cli/CONTRIBUTING.md)
811
- [ ] I have coordinated with the docs team ([email protected]) if this PR deletes files or changes any file names or file extensions.
912
- [ ] Pull request includes test coverage for the included changes.
1013
- [ ] 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.

CONTRIBUTING.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -29,13 +29,13 @@ This repository contains notebooks and sample code that demonstrate how to devel
2929

3030
## Issues
3131

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.
3333

3434
## Repository structure
3535

3636
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`.
3737

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.
3939

4040
## Pull Requests
4141

@@ -67,30 +67,33 @@ Also if adding new examples or changing existing descriptions, run the `readme.p
6767
python readme.py
6868
```
6969

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.
7171

7272
### Discoverability
7373

7474
Examples in this repository can be indexed in the [Microsoft code samples browser](https://docs.microsoft.com/samples), enabling organic discoverability. To accomplish this:
7575

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).
7777
- add required YAML frontmatter at the top of the `README.md`
7878

79-
The YAML frontmatter is this:
79+
The YAML frontmatter format looks like this:
8080

8181
```YAML
8282
---
8383
page_type: sample
8484
languages:
8585
- azurecli
86-
- python
86+
- language1
87+
- language2
8788
products:
8889
- azure-machine-learning
8990
description: Example description.
9091
---
9192
```
9293

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.
9497

9598
### Other resources
9699
* [CLI contributing guide.](cli/CONTRIBUTING.md)

sdk/CONTRIBUTING.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
[Azure/azureml-examples overall contributing guide.](../CONTRIBUTING.md)
2+
3+
## Adding a new SDK sample
4+
5+
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

Comments
 (0)