From fbca8553835e97f7b39872ccb9b55424166a1459 Mon Sep 17 00:00:00 2001 From: Rahul Devikar Date: Wed, 5 Nov 2025 23:01:05 -0800 Subject: [PATCH 1/2] Add Issue Templates --- .github/ISSUE_TEMPLATE/bug_report.yml | 55 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 7 +++ .github/ISSUE_TEMPLATE/feature_request.yml | 48 +++++++++++++++++++ 3 files changed, 110 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..69b11048 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,55 @@ +name: Bug Report +description: Report an issue with the project. +title: "[BUG] - [short description]" +labels: bug +assignees: '' + +body: + - type: markdown + attributes: + value: | + ## Bug Report + + Please fill out the following information to help us better understand the issue. + + - type: input + attributes: + label: "Bug Description" + description: "Provide a clear and concise description of the bug." + placeholder: "e.g., The app crashes when I try to login." + required: true + + - type: textarea + attributes: + label: "Steps to Reproduce" + description: "List the steps to reproduce the behavior." + placeholder: "e.g., 1. Go to login page, 2. Enter username and password, 3. Click login" + required: true + + - type: input + attributes: + label: "Expected Behavior" + description: "What did you expect to happen?" + placeholder: "e.g., The app should log me in successfully." + required: true + + - type: input + attributes: + label: "Environment" + description: "Please specify the environment where the bug occurs (e.g., OS, browser version)." + placeholder: "e.g., Windows 10, Chrome 92" + required: true + + - type: input + attributes: + label: "Version" + description: "What version of the project are you using?" + placeholder: "e.g., 1.0.0" + required: true + + - type: textarea + attributes: + label: "Additional Context" + description: "Add any other context or screenshots that might help us understand the issue." + placeholder: "e.g., Logs, stack traces, screenshots" + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..2f9584fe --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,7 @@ +# .github/ISSUE_TEMPLATE/config.yml +default: + - bug_report + - feature_request +labels: + - "type: bug" + - "type: enhancement" diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 00000000..0b4a9e50 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,48 @@ +name: Feature Request +description: Suggest a new feature or improvement. +title: "[FEATURE] - [short description]" +labels: enhancement +assignees: '' + +body: + - type: markdown + attributes: + value: | + ## Feature Request + + Please fill out the following template to help us evaluate your request. + + - type: input + attributes: + label: "Feature Description" + description: "Describe the feature or enhancement you would like to see." + placeholder: "e.g., Add dark mode support to the app." + required: true + + - type: textarea + attributes: + label: "Use Case" + description: "What problem does this feature solve or how would it improve the project?" + placeholder: "e.g., Dark mode would make the app more comfortable to use at night." + required: true + + - type: input + attributes: + label: "Potential Impact" + description: "How would this feature impact the project or the user experience?" + placeholder: "e.g., It would improve accessibility for users with vision impairments." + required: true + + - type: input + attributes: + label: "Priority" + description: "How important is this feature? (Low, Medium, High)" + placeholder: "e.g., High" + required: true + + - type: textarea + attributes: + label: "Additional Context" + description: "Add any other information that might be helpful." + placeholder: "e.g., Related issues, screenshots, external resources." + required: false From 4dd55e8b5789fd81c0f61759c195071c34576cf4 Mon Sep 17 00:00:00 2001 From: Rahul Devikar Date: Wed, 5 Nov 2025 23:17:40 -0800 Subject: [PATCH 2/2] Add Issue Templates --- .github/ISSUE_TEMPLATE/bug_report.yml | 121 ++++++++++++++++++--- .github/ISSUE_TEMPLATE/config.yml | 20 +++- .github/ISSUE_TEMPLATE/feature_request.yml | 60 +++++++--- 3 files changed, 167 insertions(+), 34 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 69b11048..da7d2070 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -1,5 +1,5 @@ name: Bug Report -description: Report an issue with the project. +description: Report an issue with the Agent365 Python SDK. title: "[BUG] - [short description]" labels: bug assignees: '' @@ -10,46 +10,137 @@ body: value: | ## Bug Report - Please fill out the following information to help us better understand the issue. + Thank you for reporting a bug in the Agent365 Python SDK! Please fill out the following information to help us diagnose and fix the issue. - type: input attributes: label: "Bug Description" description: "Provide a clear and concise description of the bug." - placeholder: "e.g., The app crashes when I try to login." + placeholder: "e.g., Agent runtime throws TypeError when processing tool responses, or observability module fails to emit telemetry events." required: true - type: textarea attributes: label: "Steps to Reproduce" - description: "List the steps to reproduce the behavior." - placeholder: "e.g., 1. Go to login page, 2. Enter username and password, 3. Click login" + description: "List the steps to reproduce the behavior. Include code snippets if possible." + placeholder: | + e.g., + 1. Import microsoft_agents_a365.runtime + 2. Create an agent with custom tools + 3. Call agent.process_activity() with a specific message + 4. Observe error in console + value: | + 1. + 2. + 3. required: true - - type: input + - type: textarea attributes: label: "Expected Behavior" description: "What did you expect to happen?" - placeholder: "e.g., The app should log me in successfully." + placeholder: "e.g., The agent should process the tool response and return a successful activity without errors." + required: true + + - type: textarea + attributes: + label: "Actual Behavior" + description: "What actually happened? Include error messages, stack traces, or unexpected output." + placeholder: | + e.g., + TypeError: 'NoneType' object is not subscriptable + File "microsoft_agents_a365/runtime/agent.py", line 123, in process_activity + required: true + + - type: dropdown + attributes: + label: "Affected SDK Component" + description: "Which Agent365 SDK package is affected?" + options: + - microsoft-agents-a365-runtime + - microsoft-agents-a365-tooling + - microsoft-agents-a365-observability-core + - microsoft-agents-a365-observability-extensions-langchain + - microsoft-agents-a365-observability-extensions-openai + - microsoft-agents-a365-observability-extensions-semantickernel + - microsoft-agents-a365-tooling-extensions-agentframework + - microsoft-agents-a365-tooling-extensions-azureaifoundry + - microsoft-agents-a365-tooling-extensions-openai + - microsoft-agents-a365-tooling-extensions-semantickernel + - microsoft-agents-a365-notifications + - Not sure / Multiple components required: true - type: input attributes: - label: "Environment" - description: "Please specify the environment where the bug occurs (e.g., OS, browser version)." - placeholder: "e.g., Windows 10, Chrome 92" + label: "SDK Version" + description: "What version of the Agent365 SDK are you using? (Run: pip show microsoft-agents-a365-runtime)" + placeholder: "e.g., 0.1.0 or 0.1.0.dev5" required: true - type: input attributes: - label: "Version" - description: "What version of the project are you using?" - placeholder: "e.g., 1.0.0" + label: "Python Version" + description: "What version of Python are you using? (Run: python --version)" + placeholder: "e.g., Python 3.11.5 or Python 3.12.0" + required: true + + - type: dropdown + attributes: + label: "Operating System" + description: "What operating system are you running on?" + options: + - Windows + - macOS + - Linux (Ubuntu) + - Linux (other distribution) + - Azure (Container Apps / App Service) + - Other required: true + - type: textarea + attributes: + label: "Environment Details" + description: "Additional environment information (virtual environment, container, cloud service, etc.)" + placeholder: | + e.g., + - Running in Docker container + - Deployed on Azure Container Apps + - Using venv virtual environment + - Running in GitHub Codespaces + required: false + + - type: textarea + attributes: + label: "Code Sample (Optional)" + description: "Provide a minimal code sample that reproduces the issue." + placeholder: | + ```python + from microsoft_agents_a365.runtime import Agent + + # Your code here that reproduces the bug + agent = Agent(...) + ``` + required: false + - type: textarea attributes: label: "Additional Context" - description: "Add any other context or screenshots that might help us understand the issue." - placeholder: "e.g., Logs, stack traces, screenshots" + description: "Add any other context, logs, stack traces, or screenshots that might help." + placeholder: | + e.g., + - Full stack trace + - Relevant log output + - Related issues or discussions + - Workarounds attempted required: false + + - type: checkboxes + attributes: + label: "Impact" + description: "How does this bug affect your work?" + options: + - label: Blocks development completely + - label: Blocks specific feature implementation + - label: Has a workaround but impacts productivity + - label: Minor issue with minimal impact diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 2f9584fe..aa9beee9 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,7 +1,15 @@ # .github/ISSUE_TEMPLATE/config.yml -default: - - bug_report - - feature_request -labels: - - "type: bug" - - "type: enhancement" +blank_issues_enabled: false +contact_links: + - name: 📚 Documentation + url: https://github.com/microsoft/Agent365-python/blob/main/README.md + about: Check the documentation for guides, API references, and examples + - name: 💬 Discussions + url: https://github.com/microsoft/Agent365-python/discussions + about: Ask questions, share ideas, and engage with the community + - name: ⚡ Quick Start Guide + url: https://github.com/microsoft/Agent365-python/blob/main/README.md#getting-started + about: Get started with the Agent365 Python SDK + - name: 🔒 Security Vulnerability + url: https://github.com/microsoft/Agent365-python/security/advisories/new + about: Report security vulnerabilities privately (do not create public issues) diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 0b4a9e50..ae1fd849 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -1,5 +1,5 @@ name: Feature Request -description: Suggest a new feature or improvement. +description: Suggest a new feature or improvement for the Agent365 Python SDK. title: "[FEATURE] - [short description]" labels: enhancement assignees: '' @@ -10,39 +10,73 @@ body: value: | ## Feature Request - Please fill out the following template to help us evaluate your request. + Thank you for suggesting a feature for the Agent365 Python SDK! Please fill out the following template to help us evaluate your request. - type: input attributes: label: "Feature Description" - description: "Describe the feature or enhancement you would like to see." - placeholder: "e.g., Add dark mode support to the app." + description: "Describe the feature or enhancement you would like to see in the Agent SDK." + placeholder: "e.g., Add support for streaming responses in the observability module, or support for custom authentication providers." required: true - type: textarea attributes: label: "Use Case" - description: "What problem does this feature solve or how would it improve the project?" - placeholder: "e.g., Dark mode would make the app more comfortable to use at night." + description: "What problem does this feature solve or how would it improve agent development?" + placeholder: "e.g., Streaming responses would allow real-time monitoring of agent interactions in production, improving debugging capabilities for long-running agents." + required: true + + - type: dropdown + attributes: + label: "Affected SDK Component" + description: "Which part of the Agent365 SDK would this feature affect?" + options: + - microsoft-agents-a365-runtime + - microsoft-agents-a365-tooling + - microsoft-agents-a365-observability-core + - microsoft-agents-a365-observability-extensions + - microsoft-agents-a365-tooling-extensions + - microsoft-agents-a365-notifications + - Documentation + - Multiple components + - Other (specify in additional context) required: true - type: input attributes: label: "Potential Impact" - description: "How would this feature impact the project or the user experience?" - placeholder: "e.g., It would improve accessibility for users with vision impairments." + description: "How would this feature impact agent development or the developer experience?" + placeholder: "e.g., Would reduce development time by 30% for implementing observability in production agents." required: true - - type: input + - type: dropdown attributes: label: "Priority" - description: "How important is this feature? (Low, Medium, High)" - placeholder: "e.g., High" + description: "How important is this feature to your agent development workflow?" + options: + - Low - Nice to have + - Medium - Would improve workflow + - High - Blocking current development + - Critical - Prevents SDK adoption required: true + - type: textarea + attributes: + label: "Proposed Solution (Optional)" + description: "If you have ideas on how this feature could be implemented, please share them." + placeholder: "e.g., Could add a StreamingObserver class that implements the Observer pattern for real-time event callbacks." + required: false + + - type: textarea + attributes: + label: "Alternative Solutions Considered" + description: "Have you considered any workarounds or alternative approaches?" + placeholder: "e.g., Currently using custom logging, but it doesn't integrate with the SDK's observability framework." + required: false + - type: textarea attributes: label: "Additional Context" - description: "Add any other information that might be helpful." - placeholder: "e.g., Related issues, screenshots, external resources." + description: "Add any other information that might be helpful (code examples, related issues, external resources)." + placeholder: "e.g., Related to #123, similar to feature in Microsoft.Agents .NET SDK, or example code showing the desired API." required: false