Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update CONTRIBUTING.md #2599

Merged
merged 13 commits into from
Sep 18, 2023
1 change: 1 addition & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,4 @@
- [ ] I have read the [contribution guidelines](https://github.com/Azure/azureml-examples/blob/main/CONTRIBUTING.md)
- [ ] I have coordinated with the docs team (mldocs@microsoft.com) if this PR deletes files or changes any file names or file extensions.
- [ ] Pull request includes test coverage for the included changes.
- [ ] 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.
diondrapeck marked this conversation as resolved.
Show resolved Hide resolved
21 changes: 7 additions & 14 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,12 @@ contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additio

## Goals

- source for all code snippets in documentation
This repository contains notebooks and sample code that demonstrate how to develop and manage ML workflows using Azure Machine Learning v2 SDK and CLI. Use the samples in this repository to try out AzureML SDK and CLI scenarios from your local machine.

## Non-goals

- serve as documentation (see https://docs.microsoft.com/azure/machine-learning)
- serve as scenario-specific project templates (coming soon!)
- This repository is not meant to serve as reference documentation. Reference documentation for the azure-ai-ml package can be found [here](https://learn.microsoft.com/en-us/python/api/azure-ai-ml/?view=azure-python).
- This repository is not meant to serve as conceptual overview or comprehensive getting started documents. All long-form textual documentation can be found [here](https://learn.microsoft.com/en-us/python/api/azure-ai-ml/?view=azure-python).
diondrapeck marked this conversation as resolved.
Show resolved Hide resolved
diondrapeck marked this conversation as resolved.
Show resolved Hide resolved

## Issues

Expand Down Expand Up @@ -92,14 +92,7 @@ description: Example description.

**Edit the description** and update the languages as needed.

### CLI 2.0

[CLI contributing guide.](cli/CONTRIBUTING.md)

### Python SDK

[Python SDK contributing guide.](python-sdk/CONTRIBUTING.md)

### Notebooks

[Notebooks contributing guide.](notebooks/CONTRIBUTING.md)
### Other resources
* [CLI contributing guide.](cli/CONTRIBUTING.md)
* [Python SDK contributing guide.](python-sdk/CONTRIBUTING.md)
* [Notebooks contributing guide.](notebooks/CONTRIBUTING.md)
Loading