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.

Sign up for GitHub

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 issue templates #4305

Merged
merged 4 commits into from
Oct 25, 2024
Merged

Update issue templates #4305

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
97ab59b
Update issue templates
theunrepentantgeek Sep 30, 2024
faa30d2
Update templates
theunrepentantgeek Oct 7, 2024
f914570
Update templates
theunrepentantgeek Oct 15, 2024
d63341b
Add suggestion to new feature template
theunrepentantgeek Oct 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 17 additions & 13 deletions .github/ISSUE_TEMPLATE/bug-report.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,14 @@ about: Create a report to help us improve
title: 'Bug: <Brief description of 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?_

<!---
The version of the operator pod.
Assuming your ASO is deployed in the default namespace, you can get this version from the container image which the controller is running.
Expand All @@ -16,18 +20,18 @@ ASO V1: `kubectl get deployment -n azureoperator-system azureoperator-controller
ASO V2: `kubectl get deployment -n azureserviceoperator-system azureserviceoperator-controller-manager -o wide` and share the image being used by the manager container.
-->

**Describe the bug**
A clear and concise description of what the bug is.
## Expected behavior
matthchr marked this conversation as resolved.
Show resolved Hide resolved

_A concise description of what you expected to happen._

## To Reproduce

_Describe the steps to recreate the issue._

**To Reproduce**
Steps to reproduce the behavior:
<Fill in the steps>
## 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._
16 changes: 9 additions & 7 deletions .github/ISSUE_TEMPLATE/improvement-template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,16 @@ about: Request an improvement to an existing feature or behavior
title: ''
labels: ''
assignees: ''

---

**Describe the current behavior**
A description of how things are today.
## Describe the current behavior

_A description of how things are today._

## Describe the improvement

_How should things be changed or improved?_

**Describe the improvement**
How should things be changed or improved?
## Additional context

**Additional context**
Add any other context about the suggested improvement.
_Add any other context about the suggested improvement._
14 changes: 12 additions & 2 deletions .github/ISSUE_TEMPLATE/new-feature-template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,17 @@ about: Request a new feature
title: 'Feature: <Briefly describe the feature>'
labels: new-feature
assignees: ''

---

<Describe the feature request>
_Describe the feature request._

<!--
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you think its worth mentioning the link to contribution guide here and encourage users to contribute if they want to?

If you want a new resource (or a new version of an existing resource), please provide a link to the ARM documentation for the resource type.

Tip: Including the search terms `Azure` `ARM` and `Bicep` can help you find the right documentation quickly.

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.
-->
30 changes: 24 additions & 6 deletions .github/pull_request_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,34 @@
<!-- Thanks for sending a pull request! Here are some tips for you:
If this PR closes another issue, add 'closes #<issue number>' somewhere in the PR summary. GitHub will automatically close that issue when this PR gets merged. Alternatively, adding 'refs #<issue number>' will not close the issue, but help provide the reviewer more context.-->

## What this PR does

_Thanks for sending a pull request! Delete this text and tell us why we need this change._

<!--

Here are some tips:

If this PR closes another issue, add 'closes #<issue number>' somewhere in the PR summary. GitHub will automatically close that issue when this PR gets merged.
Alternatively, adding 'refs #<issue number>' will not close the issue, but help provide the reviewer more context.

Closes #[issue number]
-->

<!--
### Special notes

matthchr marked this conversation as resolved.
Show resolved Hide resolved
**What this PR does / why we need it**:
_If there's anything complex or unusual about this PR that would help us review it, let us know here. Otherwise delete this section._
-->

**Special notes for your reviewer**:
## 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]._
-->
matthchr marked this conversation as resolved.
Show resolved Hide resolved

- [ ] this PR contains documentation
- [ ] this PR contains tests
- [ ] this PR contains YAML Samples
Loading