Update Issue Template and PR Template (#1801)

* Add issue template and feature request template

* Update pr template

* Fix broken link
This commit is contained in:
kdestin 2022-10-28 14:21:32 -04:00 коммит произвёл GitHub
Родитель 1dbb0c13d2
Коммит d170fff3d2
7 изменённых файлов: 98 добавлений и 57 удалений

77
.github/ISSUE_TEMPLATE/bug.yml поставляемый Normal file
Просмотреть файл

@ -0,0 +1,77 @@
name: Bug Report
description: File a bug report for one of the examples
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
Thank you for taking the time to fill out this bug report!
Please note that the bug reports in this repository are for bugs with our community-driven examples.
* For issues with the ML extension for Azure CLI, [please open an issue here](https://github.com/azure/azure-cli-extensions/issues/new/choose)
* For issues with the Azure ML Python SDK, [please open an issue here](https://github.com/azure/azure-sdk-for-python/issues/new/choose)
- type: markdown
attributes:
value: |
# Environment
- type: dropdown
id: os
attributes:
label: "Operating System"
multiple: false
options:
- Windows
- Linux
- MacOS
validations:
required: true
- type: textarea
id: version
attributes:
label: Version Information
description: |
What version of our software are you running?
* If this is an issue for a CLI sample, please paste the content of `az version --output=yaml`
* If this is an issue for an SDK sample, please provide the following:
```
Python Version:
azure-ai-ml package version:
```
validations:
required: true
- type: markdown
attributes:
value: |
# Describe the problem
- type: textarea
id: reproduce-steps
attributes:
label: Steps to reproduce
description: Please provide minimal required steps to reproduce the bug.
placeholder: |
1. Step one.
2. Step two.
3. Step three.
validations:
required: true
- type: textarea
id: expected-behavior
attributes:
label: Expected behavior
description: What was the expected behavior?
validations:
required: true
- type: textarea
id: actual-behavior
attributes:
label: Actual behavior
description: What was the actual behavior?
validations:
required: true
- type: textarea
id: logs
attributes:
label: Addition information
description: If there is any additional information relevant to this issue, please include below.

3
.github/ISSUE_TEMPLATE/config.yml поставляемый
Просмотреть файл

@ -6,3 +6,6 @@ contact_links:
- name: Python SDK issues
url: https://github.com/azure/azure-sdk-for-python/issues/new/choose
about: Please open issues with the Azure ML Python SDK here
- name: Azure Machine Learning Documentation
url: https://docs.microsoft.com/en-us/azure/machine-learning/
about: Please read through our documentation in the event it addresses your concern(s)

16
.github/ISSUE_TEMPLATE/example-issue.md поставляемый
Просмотреть файл

@ -1,16 +0,0 @@
---
name: Report an issue with an example
about: Having an issue with one of the examples?
title: ''
labels: 'example issue'
assignees: ''
---
## Which example? Describe the issue
example:
description:
## Additional context
-

16
.github/ISSUE_TEMPLATE/example-request.md поставляемый
Просмотреть файл

@ -1,16 +0,0 @@
---
name: Request a new example
about: Want to request a new example?
title: ''
labels: 'example request'
assignees: ''
---
## What example? Describe it
example:
description:
## Additional context
-

14
.github/ISSUE_TEMPLATE/feature.yml поставляемый Normal file
Просмотреть файл

@ -0,0 +1,14 @@
name: Feature Request
description: Request a new example, an enhancement for an existing example, or an enhancement for the repo itself
labels: ["enhancement"]
body:
- type: textarea
id: feature
attributes:
label: Describe your suggestion
validations:
required: true
- type: textarea
id: more-details
attributes:
label: Additional details

15
.github/ISSUE_TEMPLATE/repo-issue.md поставляемый
Просмотреть файл

@ -1,15 +0,0 @@
---
name: Suggest an enhancement for this repo
about: Have an idea for general improvements to this repository?
title: ''
labels: 'enhancement'
assignees: ''
---
## Describe it
description:
## Additional context
-

14
.github/PULL_REQUEST_TEMPLATE.md поставляемый
Просмотреть файл

@ -1,14 +1,8 @@
# PR into Azure/azureml-examples
# Description
## Checklist
I have:
# Checklist
- [ ] read and followed the contributing guidelines
## Changes
-
fixes #
- [ ] I have read the [contribution guidelines](https://github.com/Azure/azureml-examples/blob/main/CONTRIBUTING.md)
- [ ] Pull request includes test coverage for the included changes.