From 97ab59be1037ed892d9f49036ca8ff9511c464b0 Mon Sep 17 00:00:00 2001 From: Bevan Arps Date: Tue, 1 Oct 2024 09:55:05 +1300 Subject: [PATCH 1/4] Update issue templates --- .github/ISSUE_TEMPLATE/bug-report.md | 32 +++++++++++-------- .../ISSUE_TEMPLATE/improvement-template.md | 15 +++++---- .../ISSUE_TEMPLATE/new-feature-template.md | 4 ++- .github/pull_request_template.md | 25 +++++++++++---- 4 files changed, 50 insertions(+), 26 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md index 73ba3d67927..2a311e69dd0 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -4,10 +4,16 @@ about: Create a report to help us improve title: 'Bug: ' labels: "bug \U0001FAB2" assignees: '' - --- -**Version of Azure Service Operator** +## Describe the bug + +_Please give a clear description of what you see and why you think it is a bug._ + +### Azure Service Operator Version + +_What version of ASO are you using?_ + -**Describe the bug** -A clear and concise description of what the bug is. +## To Reproduce + +_Describe the steps to recreate the issue._ + +## Expected behavior + +_A concise description of what you expected to happen._ -**To Reproduce** -Steps to reproduce the behavior: - +## Screenshots -**Expected behavior** -A clear and concise description of what you expected to happen. +_If applicable, add screenshots to help explain your problem._ -**Screenshots** -If applicable, add screenshots to help explain your problem. +## Additional context -**Additional context** -Add any other context about the problem here. +_Add any other context about the problem here._ diff --git a/.github/ISSUE_TEMPLATE/improvement-template.md b/.github/ISSUE_TEMPLATE/improvement-template.md index bfca3b4c742..e19bc83c488 100644 --- a/.github/ISSUE_TEMPLATE/improvement-template.md +++ b/.github/ISSUE_TEMPLATE/improvement-template.md @@ -7,11 +7,14 @@ assignees: '' --- -**Describe the current behavior** -A description of how things are today. +## Describe the current behavior -**Describe the improvement** -How should things be changed or improved? +_A description of how things are today._ -**Additional context** -Add any other context about the suggested improvement. +## Describe the improvement + +_How should things be changed or improved?_ + +## Additional context + +_Add any other context about the suggested improvement._ diff --git a/.github/ISSUE_TEMPLATE/new-feature-template.md b/.github/ISSUE_TEMPLATE/new-feature-template.md index 71a13b2bb56..29cf52d828e 100644 --- a/.github/ISSUE_TEMPLATE/new-feature-template.md +++ b/.github/ISSUE_TEMPLATE/new-feature-template.md @@ -7,4 +7,6 @@ assignees: '' --- - +## Feature Request + +_Describe the feature request._ diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 32fa4772540..6ae84793811 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,16 +1,29 @@ - + +## What this PR does + +_Delete this text and tell us why we need this change._ + + -**What this PR does / why we need it**: +### Special notes -**Special notes for your reviewer**: +_If there's anything complex or unusual about this PR that would help us review it, let us know here. Otherwise delete this section._ + +## How does this PR make you feel? -**How does this PR make you feel**: ![gif](https://giphy.com/) -**If applicable**: +## Checklist + +_Delete any that don't apply. For completed items, change [ ] to [x]._ + - [ ] this PR contains documentation - [ ] this PR contains tests - [ ] this PR contains YAML Samples From faa30d283261e594f2529d97bf4fc17e968726bb Mon Sep 17 00:00:00 2001 From: Bevan Arps Date: Tue, 8 Oct 2024 08:05:06 +1300 Subject: [PATCH 2/4] Update templates --- .github/ISSUE_TEMPLATE/bug-report.md | 12 +++++------- .github/ISSUE_TEMPLATE/improvement-template.md | 1 - .github/ISSUE_TEMPLATE/new-feature-template.md | 2 -- .github/pull_request_template.md | 8 ++++++-- 4 files changed, 11 insertions(+), 12 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md index 2a311e69dd0..994fd0e5f90 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -10,9 +10,7 @@ assignees: '' _Please give a clear description of what you see and why you think it is a bug._ -### Azure Service Operator Version - -_What version of ASO are you using?_ +Azure Service Operator Version: _What version of ASO are you using?_ -## To Reproduce - -_Describe the steps to recreate the issue._ - ## Expected behavior _A concise description of what you expected to happen._ +## To Reproduce + +_Describe the steps to recreate the issue._ + ## Screenshots _If applicable, add screenshots to help explain your problem._ diff --git a/.github/ISSUE_TEMPLATE/improvement-template.md b/.github/ISSUE_TEMPLATE/improvement-template.md index e19bc83c488..bc6e7d2c524 100644 --- a/.github/ISSUE_TEMPLATE/improvement-template.md +++ b/.github/ISSUE_TEMPLATE/improvement-template.md @@ -4,7 +4,6 @@ about: Request an improvement to an existing feature or behavior title: '' labels: '' assignees: '' - --- ## Describe the current behavior diff --git a/.github/ISSUE_TEMPLATE/new-feature-template.md b/.github/ISSUE_TEMPLATE/new-feature-template.md index 29cf52d828e..4f7d5110916 100644 --- a/.github/ISSUE_TEMPLATE/new-feature-template.md +++ b/.github/ISSUE_TEMPLATE/new-feature-template.md @@ -7,6 +7,4 @@ assignees: '' --- -## Feature Request - _Describe the feature request._ diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 6ae84793811..0f9be701b14 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,10 +1,10 @@ ## What this PR does -_Delete this text and tell us why we need this change._ +_Thanks for sending a pull request! Delete this text and tell us why we need this change._ ## How does this PR make you feel? @@ -22,7 +24,9 @@ _If there's anything complex or unusual about this PR that would help us review ## Checklist + - [ ] this PR contains documentation - [ ] this PR contains tests From f91457062526f6d8f2fc947a5b6d7b9cd734ab17 Mon Sep 17 00:00:00 2001 From: Bevan Arps Date: Wed, 16 Oct 2024 09:01:51 +1300 Subject: [PATCH 3/4] Update templates --- .github/ISSUE_TEMPLATE/new-feature-template.md | 10 +++++++++- .github/pull_request_template.md | 5 +++-- 2 files changed, 12 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/new-feature-template.md b/.github/ISSUE_TEMPLATE/new-feature-template.md index 4f7d5110916..760b89ff039 100644 --- a/.github/ISSUE_TEMPLATE/new-feature-template.md +++ b/.github/ISSUE_TEMPLATE/new-feature-template.md @@ -4,7 +4,15 @@ about: Request a new feature title: 'Feature: ' labels: new-feature assignees: '' - --- _Describe the feature request._ + + diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 0f9be701b14..865436c21f8 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -5,16 +5,17 @@ _Thanks for sending a pull request! Delete this text and tell us why we need thi + From d63341bfb1f0b20b3f69bbb648aa87a5dba28ca0 Mon Sep 17 00:00:00 2001 From: Bevan Arps Date: Fri, 25 Oct 2024 08:11:50 +1300 Subject: [PATCH 4/4] Add suggestion to new feature template --- .github/ISSUE_TEMPLATE/new-feature-template.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/new-feature-template.md b/.github/ISSUE_TEMPLATE/new-feature-template.md index 760b89ff039..8d49a19ed12 100644 --- a/.github/ISSUE_TEMPLATE/new-feature-template.md +++ b/.github/ISSUE_TEMPLATE/new-feature-template.md @@ -15,4 +15,6 @@ Tip: Including the search terms `Azure` `ARM` and `Bicep` can help you find the E.g. A Google search for `azure arm bicep storage queue` returns the following link as the first result: https://learn.microsoft.com/en-us/azure/templates/microsoft.storage/storageaccounts/queueservices/queues?pivots=deployment-language-arm-template + +If you'd like to bypass our prioritization process and implement a new resource yourself, check out our contribution guide [Adding a new code-generated resource](https://azure.github.io/azure-service-operator/contributing/add-a-new-code-generated-resource/). In most cases a new contributor can implement a new resource in a couple of days - and we're here to help you. -->