From 7771f398518865cde7ffb317bebe83beca146664 Mon Sep 17 00:00:00 2001 From: Diondra <16376603+diondrapeck@users.noreply.github.com> Date: Mon, 18 Sep 2023 13:14:06 -0500 Subject: [PATCH] Update CONTRIBUTING.md (#2599) * 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 CONTRIBUTING.md links --- .github/PULL_REQUEST_TEMPLATE.md | 1 + CONTRIBUTING.md | 21 ++++++--------------- 2 files changed, 7 insertions(+), 15 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 3fb98af839..0c8ff6a495 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -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. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c0e37466a7..d14591b2fd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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. Small code examples that are just comprehensive enough to show how an object or function works are categorized as reference documentation and should be placed in the object or function docstring in the [azure-ai-ml folder of the azure-sdk-for-python repository](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/ml/azure-ai-ml) following [these guidelines](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/ml/azure-ai-ml/documentation_guidelines.md). +- This repository is not the place for long-form textual documentation. Documentation resources containing minimal or no code should be added in the [azure-docs repository](https://github.com/MicrosoftDocs/azure-docs). ## Issues @@ -71,7 +71,7 @@ This will also generate a GitHub Actions workflow file for any new examples in t ### Discoverability -Examples in this repository can be index in the [Microsoft code samples browser](https://docs.microsoft.com/samples), enabling organic discoverability. To accomplish this: +Examples in this repository can be indexed in the [Microsoft code samples browser](https://docs.microsoft.com/samples), enabling organic discoverability. To accomplish this: - add an excellent `README.md` file in the example directory - add required YAML frontmatter at the top of the `README.md` @@ -92,14 +92,5 @@ 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)