From 3e65787dddc4e429f18a2e139457fab3e1119420 Mon Sep 17 00:00:00 2001 From: Jeremiah Lowin <153965+jlowin@users.noreply.github.com> Date: Sun, 20 Apr 2025 17:01:38 -0700 Subject: [PATCH] Add issue templates --- .github/ISSUE_TEMPLATE/bug.yml | 63 ++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/enhancement.yml | 38 ++++++++++++++++ 2 files changed, 101 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug.yml create mode 100644 .github/ISSUE_TEMPLATE/enhancement.yml diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml new file mode 100644 index 000000000..c17509b79 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -0,0 +1,63 @@ +name: 🐛 Bug Report +description: Report a bug or unexpected behavior in FastMCP +labels: [bug, pending] + +body: + - type: markdown + attributes: + value: Thank you for contributing to FastMCP! 🙏 + + - type: textarea + id: description + attributes: + label: Description + description: | + Please explain what you're experiencing and what you would expect to happen instead. + + Provide as much detail as possible to help us understand and solve your problem quickly. + validations: + required: true + + - type: textarea + id: example + attributes: + label: Example Code + description: > + If applicable, please provide a self-contained, + [minimal, reproducible example](https://stackoverflow.com/help/minimal-reproducible-example) + demonstrating the bug. + + placeholder: | + from fastmcp import FastMCP + + ... + render: Python + + - type: textarea + id: version + attributes: + label: Version Information + description: | + Please provide information about your FastMCP version, MCP version, Python version, and OS. + + To get this information, run the following command in your terminal and paste the output below: + + ```bash + fastmcp version + ``` + + If there is other information that would be helpful, please include it as well. + render: Text + validations: + required: true + + - type: textarea + id: additional_context + attributes: + label: Additional Context + description: | + Add any other context about the problem here. This could include: + - The full error message and traceback (if applicable) + - Information about your environment (e.g., virtual environment, installed packages) + - Steps to reproduce the issue + - Any recent changes in your code or setup that might be relevant diff --git a/.github/ISSUE_TEMPLATE/enhancement.yml b/.github/ISSUE_TEMPLATE/enhancement.yml new file mode 100644 index 000000000..ecbd23531 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/enhancement.yml @@ -0,0 +1,38 @@ +name: 💡 Enhancement Request +description: Suggest an idea or improvement for FastMCP +labels: [enhancement, pending] + +body: + - type: markdown + attributes: + value: Thank you for contributing to FastMCP! We value your ideas for improving the framework. 💡 + + - type: textarea + id: description + attributes: + label: Enhancement Description + description: | + Please describe the enhancement you'd like to see in FastMCP. + + - What problem would this solve? + - How would this improve your workflow or experience with FastMCP? + - Are there any alternative solutions you've considered? + validations: + required: true + + - type: textarea + id: use_case + attributes: + label: Use Case + description: | + Describe a specific use case or scenario where this enhancement would be beneficial. + If possible, provide an example of how you envision using this feature. + + - type: textarea + id: example + attributes: + label: Proposed Implementation + description: > + If you have ideas about how this enhancement could be implemented, + please share them here. Code snippets, pseudocode, or general approaches are welcome. + render: Python