-
Notifications
You must be signed in to change notification settings - Fork 81
feat: add issue templates for bug reports and feature requests #3050
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
Open
sajeetharan
wants to merge
4
commits into
main
Choose a base branch
from
issue-template
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
a4e7804
feat: add issue templates for bug reports and feature requests
sajeetharan ececa8c
Update .github/ISSUE_TEMPLATE/bug_report.yml
sajeetharan c7b5c03
Update .github/ISSUE_TEMPLATE/feature_request.yml
sajeetharan b02cc63
Update .github/ISSUE_TEMPLATE/bug_report.yml
sajeetharan File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,102 @@ | ||
| name: Bug Report | ||
| description: Report a bug or unexpected behavior with Azure Cosmos DB for NoSQL | ||
| title: "[Bug]: " | ||
| labels: ["bug"] | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Thanks for taking the time to report a bug! Please fill out the information below to help us investigate. | ||
|
|
||
| - type: textarea | ||
| id: description | ||
| attributes: | ||
| label: Description | ||
| description: A clear and concise description of the bug. | ||
| placeholder: Describe what happened and what you expected to happen. | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: steps-to-reproduce | ||
| attributes: | ||
| label: Steps to Reproduce | ||
| description: Steps to reproduce the behavior. | ||
| placeholder: | | ||
| 1. Open... | ||
| 2. Click on... | ||
| 3. Scroll down to... | ||
| 4. See error | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: expected-behavior | ||
| attributes: | ||
| label: Expected Behavior | ||
| description: What did you expect to happen? | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: actual-behavior | ||
| attributes: | ||
| label: Actual Behavior | ||
| description: What actually happened? Include error messages or screenshots if applicable. | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: input | ||
| id: extension-version | ||
| attributes: | ||
| label: Extension Version | ||
| description: "The version of the Azure Databases extension (find it in VS Code: Extensions panel → Azure Databases)." | ||
|
sajeetharan marked this conversation as resolved.
Outdated
|
||
| placeholder: "e.g., 0.20.0" | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: input | ||
| id: vscode-version | ||
| attributes: | ||
| label: VS Code Version | ||
| description: "The version of VS Code (find it via Help → About)." | ||
| placeholder: "e.g., 1.90.0" | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: dropdown | ||
| id: os | ||
| attributes: | ||
| label: Operating System | ||
| options: | ||
| - Windows | ||
| - macOS | ||
| - Linux | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: input | ||
| id: os-version | ||
| attributes: | ||
| label: OS Version | ||
| description: The specific version of your operating system. | ||
| placeholder: "e.g., Windows 11 23H2, macOS 14.5, Ubuntu 24.04" | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: dropdown | ||
| id: connection-type | ||
| attributes: | ||
| label: Connection Type | ||
| description: How are you connecting to the database? | ||
| options: | ||
| - Azure subscription (signed in) | ||
| - Connection string | ||
| - Emulator | ||
| - Other | ||
|
|
||
| - type: textarea | ||
| id: additional-context | ||
| attributes: | ||
| label: Additional Context | ||
| description: Add any other context, logs, or screenshots about the problem here. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| blank_issues_enabled: false | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This will unfortunately break the "Report Issue" feature in Azure Resources, they inject a template through the body for a blank issue: https://github.com/microsoft/vscode-azuretools/blob/main/utils/src/reportAnIssue.ts#L84-L88 |
||
| contact_links: | ||
| - name: Documentation | ||
| url: https://github.com/microsoft/vscode-cosmosdb#readme | ||
| about: Check the documentation before filing an issue. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| name: Feature Request | ||
| description: Suggest a new feature or enhancement for Azure Cosmos DB for NoSQL | ||
| title: "[Feature]: " | ||
| labels: ["enhancement"] | ||
|
sajeetharan marked this conversation as resolved.
|
||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Thanks for suggesting a feature! Please provide as much detail as possible. | ||
|
|
||
| - type: textarea | ||
| id: problem | ||
| attributes: | ||
| label: Problem Statement | ||
| description: What problem are you trying to solve? Is this related to a frustration with the current experience? | ||
| placeholder: "I'm always frustrated when..." | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: solution | ||
| attributes: | ||
| label: Proposed Solution | ||
| description: Describe the solution you'd like to see. | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: alternatives | ||
| attributes: | ||
| label: Alternatives Considered | ||
| description: Describe any alternative solutions or workarounds you've considered. | ||
|
|
||
| - type: textarea | ||
| id: additional-context | ||
| attributes: | ||
| label: Additional Context | ||
| description: Add any other context, mockups, or screenshots about the feature request here. | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.