diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..da7d2070 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,146 @@ +name: Bug Report +description: Report an issue with the Agent365 Python SDK. +title: "[BUG] - [short description]" +labels: bug +assignees: '' + +body: + - type: markdown + attributes: + value: | + ## Bug Report + + 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., 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. 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: textarea + attributes: + label: "Expected Behavior" + description: "What did you expect to happen?" + 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: "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: "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, 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 new file mode 100644 index 00000000..aa9beee9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,15 @@ +# .github/ISSUE_TEMPLATE/config.yml +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 new file mode 100644 index 00000000..ae1fd849 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,82 @@ +name: Feature Request +description: Suggest a new feature or improvement for the Agent365 Python SDK. +title: "[FEATURE] - [short description]" +labels: enhancement +assignees: '' + +body: + - type: markdown + attributes: + value: | + ## Feature 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 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 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 agent development or the developer experience?" + placeholder: "e.g., Would reduce development time by 30% for implementing observability in production agents." + required: true + + - type: dropdown + attributes: + label: "Priority" + 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 (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